Commit Graph

597 Commits

Author SHA1 Message Date
S.H. 5f9cf32ce2
Fix images link in user/posting.md for ja, pl and zh-cn (#1591) 2025-01-31 08:57:52 +01:00
Renaud Chaput e2218cf3f8
Add documentation for the new prometheus exporter feature (#1589)
See https://github.com/mastodon/mastodon/pull/33734
2025-01-27 15:30:54 +01:00
Brook Miles a6e92cd1b1
include migration steps to stop the redis-server service on your new machine before copying the redis dump file (#1587)
* include migration steps to stop the redis-server service on your new machine before copying the redis dump file

* use single command for redis-cli SAVE instead of opening then exiting the interactive client
2025-01-23 09:05:08 +01:00
Christian Schmidt 91c68f33b3
Add documentation for `attribution_domains` (#1558)
* Add attribution_domains

* Adjust version

Co-authored-by: Claire <claire.github-309c@sitedethib.com>

* Moved to CredentialAccount

* Revert merge error

---------

Co-authored-by: Claire <claire.github-309c@sitedethib.com>
2025-01-17 09:48:02 +01:00
Matt Jankowski ccaaa4d89d
Update hugo to version 0.140.2, GH actions to latest (#1573)
* Move pagination config to own section (deprecation warning)

* Update hugo to version 0.140.0

* Update actions/checkout to v4

* Update actions/configure-pages to v5

* Update actions/upload-pages-artifact to v3

* Update actions/deploy-pages to v4

* Update hugo to version 0.140.2
2025-01-10 17:02:17 +01:00
Matt Jankowski 4afe1ae06f
Add explanation of rate limit in scheduled status entity (#1584)
* Add explanation of rate limit in scheduled status entity

* Add deprecated note
2025-01-09 15:15:41 +01:00
Matt Jankowski 441d374ce6
Restore `application_id` docs (#1583)
* Revert "Remove accidentally included `application_id` params attribute from `ScheduledStatus` (#1572)"

This reverts commit 1204ebeab8.

* Add note about the utter contempt we hold for this useless value

* Update ScheduledStatus.md

Co-authored-by: Claire <claire.github-309c@sitedethib.com>

* Update ScheduledStatus.md

Co-authored-by: David Roetzel <david@roetzel.de>

---------

Co-authored-by: Claire <claire.github-309c@sitedethib.com>
Co-authored-by: David Roetzel <david@roetzel.de>
2025-01-09 14:48:47 +01:00
Katherina Walshe-Grey f06dbf7a14
Draw attention to CORS requirements for WebFinger (#1581)
Adds a callout box mentioning that CORS headers must be set if WebFinger requests are being redirected to support a customised WEB_DOMAIN value.

This requirement is not called out in the text (only the nginx config example next to it), and is non-obvious enough that, anecdotally, many servers do not implement it properly.

See: https://github.com/mastodon/mastodon/issues/26995
2025-01-06 10:18:36 +01:00
Nik Clayton 047de3b135
fix: AccountWarning.status_ids can be null (#1580) 2025-01-03 17:23:40 +01:00
Claire 4f8a46d859
Fix incorrect `relationship_severance_event` attribute name in notifications documentation (#1579)
See https://github.com/mastodon/mastodon/issues/33411
2025-01-03 13:59:30 +01:00
Bastian c7d6167dbc
Document Authorization header for WebSocket API (#1576)
Fixes #1575

Co-authored-by: Bastian Blank <waldi@debian.org>
2024-12-19 08:57:37 +01:00
Claire 5c792e83d9
Fix incorrect documentation for RelationshipSeveranceEvent (#1557)
Fixes #1556
2024-12-18 17:03:49 +00:00
Renaud Chaput cf628c44aa
Document the new `QUERY_LOG_TAGS_ENABLED` variable (#1574)
See https://github.com/mastodon/mastodon/pull/33342
2024-12-18 11:05:11 +01:00
Matt Jankowski 1204ebeab8
Remove accidentally included `application_id` params attribute from `ScheduledStatus` (#1572) 2024-12-17 09:54:37 +01:00
FuchsFuchs1 d7d937847a
fixed incorrect minio example policy (#1571)
* fixed policy for minio mastodon bucket

* fixed example to fit instructions
2024-12-16 08:34:41 +01:00
Matt Jankowski afe3b8f3f0
Add media attachment description limit (#1567)
* Add media `description_limit` to instance

* Add media `description_limit` to instance
2024-12-04 16:10:24 +01:00
Nik Clayton 2e40eecb12
fix: Show FeaturedTag.last_status_at as a date (#1566)
* fix: FeaturedTag.last_status_at is a date

* Update example
2024-12-02 08:47:46 +01:00
Nik Clayton 49868155b9
feat: Document datetime and date formats (#1565)
Add a new document that precisely describes the string representation of
datetime and date types.

The previous description of them as "ISO 8601 Datetime" was very
imprecise, as ISO 8601 describes many different ways of representing a
datetime and date.

Specify the datetime format precisely as the ISO 8601 profile described
in RFC 3339, and the date format precisely as the "Complete date" format
from the W3C note on date and time formats.

Adjust all the references to ISO 8601 datetimes or dates to link back
to the definition.

Fixes #1420
2024-11-27 15:08:51 +00:00
Andy Piper 09dc6a85cd
e-mail -> email in most documentation references. (#1365) 2024-11-22 16:33:04 +00:00
Nik Clayton 9a8c9659b0
fix: Replace "interacted with" with "reblogged" (#1564)
By clear about the situations in which the `update` status type is sent.
2024-11-22 10:08:47 +01:00
Shlee f25f26732b
Docs to match #32908 - REPLICA_DB_TASKS / REPLICA_PREPARED_STATEMENTS (#1561)
* Update scaling.md

* Update scaling.md

* Update scaling.md
2024-11-19 13:25:40 +01:00
Benoit 0b15ac190f
Update postgresql version in path (#1544)
apt.postgresql.org defaults to v17 for Ubuntu 24.04.
2024-10-10 19:06:32 +02:00
David Roetzel 4a0d6cc7ce
Fix typo in oauth api parameters (#1545)
Fix typo.
2024-10-10 18:59:26 +02:00
Emelia Smith cb3aa4de10
Document new OAuth changes for 4.3.0 (#1445)
* Improve deprecation messaging for Application#vapid_key

* Format JSON examples in Instance methods

* Remove vapid_key from Apps API examples, since this property is deprecated on Application entity

* Add documentation for new OAuth 2.0 features added in 4.3.0

* Improve documentation for oauth-scopes

* Update content/en/api/oauth-scopes.md

Co-authored-by: Matt Jankowski <matt@jankowski.online>

* Update content/en/api/oauth-scopes.md

Co-authored-by: Matt Jankowski <matt@jankowski.online>

* Update content/en/api/oauth-scopes.md

Co-authored-by: Matt Jankowski <matt@jankowski.online>

* Update content/en/api/oauth-scopes.md

Co-authored-by: Matt Jankowski <matt@jankowski.online>

* Add deprecated and removed shortcode labels

* Use deprecated and removed shortcodes

* Improve OAuth documentation

* More OAuth documentation improvements

* Correct streaming API documentation after 4.2.0 changes

* Add note about improved Push Subscription API validation in 4.3.0

* Fix inconsistent OAuth label formatting

* Add note that there is a relationship between Accounts and the Application used to create them

* Add note that application registration endpoint also supports JSON bodies

* Be consistent in the formatting of placeholder values for Bearer tokens

* code review changes

* Slight changes in wording

* Add documentation for PKCE

* Removal of crypto oauth scope

* Cross-link authorization's scope with the OAuth Scopes documentation

* Update content/en/methods/oauth.md

* Update content/en/api/oauth-scopes.md

---------

Co-authored-by: Matt Jankowski <matt@jankowski.online>
Co-authored-by: David Roetzel <david@roetzel.de>
2024-10-10 14:44:19 +02:00
Claire c99799ac3e
Add documentation for `include_filtered` (#1543)
* Add documentation for `include_filtered`

* Update grouped_notifications.md
2024-10-09 16:54:13 +02:00
John Haugabook b0c7cca93b
manrope.scss - include manrope folder in path (#1515)
Add manrope folder to path for font manrope-variable.woff2.
2024-10-09 12:36:10 +01:00
Alyx 4f83524882
Remove instructions for cleanup crons (#1529)
Since the retention policy for cached content and media was added (#19232) a external cron is no longer needed.
2024-10-08 16:08:38 +02:00
David Roetzel 1fc8c2a889
Update installation instructions for 4.3 on Ubuntu 24.04 and Debian 12 (#1537)
* Update installation instructions...

...for Mastodon 4.3 on Ubuntu 24.04 and Debian 12.

* Reorder sections

To get rid of specifying a ruby version. Also simplifies the
steps even further.

* Allow other users to traverse mastodon home

instead of using group permissions. We heard a lot of
different opinions on this and it is clearly not a
solution for everyone, but in contrast to the group
permissions:

* `www-data` will not get write access to mastodon files
* this works identical on Debian and Ubuntu
2024-10-08 14:31:52 +02:00
Michael Stanclift 4d3746f37d
Update all Mastodon product screenshots to 4.3 (#1520)
update all using mastodon screenshots
2024-10-08 11:25:04 +01:00
Claire 42a8dbc20d
Clarify `group_key` for ungrouped notifications (#1539)
* Clarify `group_key` for ungrouped notifications

* Clarify that `grouped_types` affects `group_key` but not streaming API

* Update content/en/methods/grouped_notifications.md

Co-authored-by: Claire <claire.github-309c@sitedethib.com>

---------

Co-authored-by: David Roetzel <david@roetzel.de>
2024-10-08 11:34:32 +02:00
Claire eadb8b98cc
Add documentation for `likes` and `shares` collections on statuses (#1542) 2024-10-08 11:33:32 +02:00
David Roetzel 958ed69559
Fix typo in redis sentinel env var names (#1540)
Fix typo
2024-10-07 11:31:15 +02:00
Claire 3803173c9e
Remove documentation for `REGEXP_TIMEOUT` environment variable (#1538)
It was only added in the development version, and removed afterwards without reaching any (pre-)release.
2024-09-30 13:47:22 +02:00
Kurt Thams e64502ca23
Remove outdated reference to DigitalOcean 1-click (#1485)
The link to DigitalOcean marketplace leads to nowhere, and there doesn't appear to be a replacement on DigitalOcean's site.
2024-09-25 16:23:19 +02:00
Johannes Ernst 41ee8f3150
Clarify the description of ALLOW_PRIVATE_ADDRESSES (#1533)
Co-authored-by: Johannes Ernst <git@j12t.org>
2024-09-25 15:49:59 +02:00
Renaud Chaput 9d2ff8b31c
Update documentation to add `follow` notifications grouping (#1536)
Related to https://github.com/mastodon/mastodon/pull/32085
2024-09-25 15:49:16 +02:00
David Roetzel f1560f9df4
Document new environment variable (#1535) 2024-09-24 18:55:20 +02:00
Tim Campbell da08916e2a
Added documentation for additional OTEL service name customization (#1534) 2024-09-23 11:13:44 +02:00
Claire 061ad3d7ba
Document `attributionDomains` (#1532) 2024-09-17 12:16:10 +02:00
Claire 2dd9d6a3e0
Add documentation for `/api/v2/notifications/:group_key/accounts` (#1531)
Also fixes a few URLs that were still referencing `v2_alpha`
2024-09-17 11:56:35 +02:00
Claire 49546c285a
Add documentation for `/api/v2/notifications/*` (#1530)
* Add documentation for `/api/v2/notifications/*`

This is a renamed and slightly updated version of https://docs.joinmastodon.org/methods/notifications_alpha/

* Update notifications_alpha.md to point to the finalized API
2024-09-17 11:39:57 +02:00
alxhu 599173ae8c
Add hint to allocate more memory if Elasticsearch crashes (#1456)
Add tip to allocate more memory if Elasticsearch crashes to elasticsearch.md

When creating Elasticsearch indicies, the process could crash if there is not enough memory allocated to the JVM runtime.

This commit adds a hint for administrators to try to allocate more memory to Elasticsearch if they're experiencing out-of-memory issues.
2024-09-13 02:25:19 -07:00
David Roetzel 54659f9371
Deprecate redis namespace (#1528)
* Deprecate `REDIS_NAMESPACE`

* Update content/en/admin/config.md

Co-authored-by: Claire <claire.github-309c@sitedethib.com>

---------

Co-authored-by: Claire <claire.github-309c@sitedethib.com>
2024-09-06 17:19:28 +02:00
David Roetzel 3b06fdb018
Redis sentinel docs (#1527)
* Add basic Redis Sentinel documentation (#1311)

* Add basic Redis Sentinel documentation

Co-authored-by: Andy Piper <andypiper@users.noreply.github.com>

* Add missing redis environment variables

And adjust and clarify a few things.

* Fix copy&paste error.

---------

Co-authored-by: Gabriel Simmer <github@gmem.ca>
Co-authored-by: Andy Piper <andypiper@users.noreply.github.com>
2024-09-05 17:29:14 +02:00
Mahan b780066232
Update rule_ids type in /v1/reports (#1467)
* Update rule_ids type in /v1/reports

* add reference to the ID docs
2024-09-04 10:10:53 +02:00
aaaaalbert dc78b2ad5f
Fix #1523, add missing link to `entities/Status` (#1524)
Add a link in the attribute description of `reblog` for the `Status` API entity which was reported missing by @nikclayton.
2024-08-30 11:38:44 +02:00
Claire 7eefdcbfc6
Add documentation for `grouped_types` parameter in grouped notifications endpoints (#1525) 2024-08-30 09:47:09 +02:00
Michael Stanclift 2dfcf2c059
Add config for MASTODON_USE_LIBVIPS (#1463)
* Docs for using libvips

* "utilizating"
2024-08-26 10:40:37 +02:00
Claire 24dd81ef49
Add documentation for `authors` attribute in preview cards (#1512)
* Add documentation for `authors` attribute in preview cards

* Add `PreviewCardAuthor` entity

* Update PreviewCard.md

* Update PreviewCardAuthor.md
2024-08-23 17:34:28 +02:00
Claire 54f7d5a63f
Add documentation for `/api/v2_alpha/notifications` (#1517)
* Add rough documentation for `/api/v2_alpha/notifications`

* Update notifications_alpha.md

* Add very rough documentation about notification groups entities

* Add documentation for `NotificationGroup` entity

* Document pagination-only `NotificationGroup` attributes

* Fix documentation issue with `/api/v2_alpha/notifications/:group_key` and add example output

* Add blurb about the goal of grouped notifications

* Update notifications_alpha.md

* Specify that the 80 limit is for notification groups, not notifications

* Add documentation for `group_key` to `Notification` entity

* Make `max_id`, `since_id` and `min_id` more explicit
2024-08-23 16:51:12 +02:00