1
0
mirror of https://github.com/mastodon/documentation synced 2025-04-11 22:56:17 +02:00

615 Commits

Author SHA1 Message Date
David Whetstone
ce8146cf60
Mark MediaAttachment.preview_url, blurhash as nullable (#1457)
* Mark MediaAttachment.preview_url as nullable

Had a payload in the wild where preview_url was `null` and the method that generates this value can certainly return `nil` if none of its conditions are met: d326ad0ed9/app/serializers/rest/media_attachment_serializer.rb (L30-L38)

Also both TootSDK and IceCubesApp have this property as nullable.

* Mark MediaAttachment.blurhash as nullable

When the attachment has type `audio`, `blurhash` is `null`.
2024-06-19 10:45:48 +02:00
Michael Stanclift
28a7f3162c
Add config for REDIS_DRIVER (#1462)
* Add REDIS_DRIVER documention

* fix typo

* add version history
2024-06-19 10:45:28 +02:00
Andy Piper
325dc1fc03
Add link to org-wide CONTRIBUTING.md (#1461) 2024-06-14 12:22:19 +01:00
Claire
878e5836b7
Add documentation for notification policies (#1447)
* Add documentation for GET /api/v1/notifications/policy

* Add documentation for `PATCH /api/v1/notifications/policy`

* Add documentation for `GET /api/v1/notifications/requests`

* Add documentation for `GET /api/v1/notifications/requests/:id`

* Add documentation for accepting and rejecting requests

* Remove redundant HTTP request examples

* Add documentation for the `NotificationPolicy` entity

* Add documentation for the `NotificationRequest` entity
2024-06-13 18:01:35 +02:00
Mahan
61d28de915
Add description to timelines/public (#1448) 2024-06-11 11:25:59 +01:00
Val Lorentz
9294788aaa
tootctl search deploy: Document changes since v3.5.0 (#1454) 2024-06-11 11:25:14 +01:00
Mahan
2557e19c63
Add description and type to /emails/confirmations (#1451) 2024-06-11 11:24:06 +01:00
Mahan
b903b07128
Add description to /followed_tags (#1452) 2024-06-11 11:18:16 +01:00
Adrian
509b20926b
Update authorized.md (#1455) 2024-06-11 11:17:47 +01:00
Mahan
662543d692
Add description to v1/markers (#1459) 2024-06-11 11:15:55 +01:00
Mahan
58deaeb0b5
Add mastodon-entities to libraries (#1434) 2024-05-21 12:24:39 +01:00
Matt Jankowski
fe1fd3f8c7
Use .Path instead of .File.Path when surrounded by with .File block (#1426)
Use `.Path` outside of `.File`
2024-05-17 16:54:22 +02:00
Emelia Smith
5f0bd3cb77
Update admin/domain_blocks to include conflict response (#1417)
* Update admin/domain_blocks to include conflict response

When creating a domain block, if there is already a domain block rule for the domain, then the existing block is returned. This documents that behavior.

I've also documented the `digest` property which was added in https://github.com/mastodon/mastodon/pull/29092

* Document digest in Admin DomainBlock Entity
2024-05-07 18:54:14 +01:00
Claire
59c5876836
Add documentation for GET /api/v1/accounts and GET /api/v1/statuses (#1433)
* Add documentation for `GET /api/v1/accounts`

See https://github.com/mastodon/mastodon/pull/27871

* Add documentation for `GET /api/v1/statuses`
2024-05-07 11:43:48 +02:00
Mahan
7403a1c55f
Make category in CustomEmoji nullable (#1435)
Update CustomEmoji.md

- Add nullable to category
2024-04-29 10:00:54 +02:00
Mahan
237a8ad45b
Fix incorrect types in Role (#1436)
Update Role.md

- Convert id to String
- Convert permissions to String
2024-04-29 10:00:41 +02:00
Matt Jankowski
07f305fe82
Add doc for AR encryption env vars (#1427) 2024-04-17 11:35:17 +02:00
Michael Stanclift
8a0b1e2079
Cleanup duplicate Redis cache instructions (#1429)
* cleanup duplicate instructions
* Update content/en/admin/scaling.md

Co-authored-by: Claire <claire.github-309c@sitedethib.com>
2024-04-11 15:37:39 +01:00
Matt Jankowski
1005443460
Add max_pinned_statuses property to instances.accounts (#1425) 2024-04-02 22:28:17 +02:00
Konrad Pozniak
ddfe7b4833
Fix docs of the Translation entity (#1423)
* Fix docs of the Translation entity

The poll attribute is an object, not an array.

* Update Translation.md

* add more information about the atachment and poll option types
2024-04-02 13:12:15 +02:00
Andy Piper
a610154747
Removed unused (not implemented) query parameter. (#1369)
Signed-off-by: Andy Piper <andypiper@users.noreply.github.com>
2024-03-29 11:18:40 +01:00
Claire
c20d658062
Document ES_CA_FILE (#1403) 2024-03-27 08:54:56 +00:00
KuJoe
8d7dae6063
Updated the migrating.md document (#1390)
* Updated the migrating.md document
Included new guidance to update the mastodon database user password, instructions to copy over the Redis database, added new flag to improve pg_restore performance, a suggestion to copy the SSL certificates over, and added the commands needed to complete the migration along with an optional command for Elasticsearch.
* Update content/en/admin/migrating.md
* Update migrating.md
Fixed wording and order of starting services.
* Updated the migration guide for Redis and services
Added more details for migrating the Redis database and where/when to stop the services.

Co-authored-by: Michael Stanclift <mx@vmstan.com>
2024-03-27 08:54:18 +00:00
Thibault Molleman
be37342395
Added clarification about blind/low-vision people to captcha.md (#1408)
The original text didn't exactly make it clear to what kind of people the use of hcaptcha was problematic
2024-03-27 08:53:13 +00:00
Alan Ye
cc8949eef2
docs: remove extra nodejs in apt install (#1418) 2024-03-27 08:51:14 +00:00
Dale Price
fa868c3a9b
Add documentation for legal report category (#1422)
This category was was added in mastodon/mastodon#23941
2024-03-27 08:49:49 +00:00
a
84ab59d3ec
Fix typos (#1419) 2024-03-27 08:49:25 +00:00
Austin Wise
fa953aae1e
Document that S3 ACLs must be enabled (#952)
When using the web GUI to create a bucket, both AWS S3 and GCS have ACLs disabled by default.
2024-03-17 19:38:18 +00:00
Claire
4e46d961ca
Mark contact[account] as nullable in Instance entity (#1415)
* Mark `contact[account]` as nullable in `Instance` entity

* Update V1_Instance.md
2024-03-13 13:56:28 +00:00
Claire
046da5d653
Add documentation for ALLOW_UNSAFE_AUTH_PRODIVER_REATTACH (#1410) 2024-02-27 18:31:39 +01:00
Claire
899339ccad
Add documentation for DISABLE_AUTOMATIC_SWITCHING_TO_APPROVED_REGISTRATIONS (#1412) 2024-02-23 15:31:36 +01:00
Claire
96cd4f2173
Add documentation for ENABLE_SIDEKIQ_UNIQUE_JOBS_UI (#1411) 2024-02-23 15:31:16 +01:00
Kevin P. Fleming
bdf33a15f2
Fully document S3 object storage. (#1393)
This rewrite documents all supported environment variables for the S3
object storage system, and in addition documents the way that Mastodon
constructs URLs that it hands to clients (for them to obtain objects
from the storage provider).

The documentation of the variables lives entirely in the object-storage page
now, instead of being mixed between that page and the main config page. A link
to the object-storage page has been added to the config page.
2024-02-20 15:10:11 +00:00
Ophélien DUPARC
1d8f602210
Update tootctl documentation to add missing argument on account - prune (#1405)
Added tootctl accounts prune help info
2024-02-20 15:07:08 +00:00
Michael Stanclift
3eea2e8800
Improve hCaptcha site key and secret key description (#1409)
Had some feedback that the directions to obtain the site key and secret key were not as clear as they could be, this breaks them into two items with a direction of where to find the secret key.
2024-02-19 23:10:57 +00:00
Ophélien DUPARC
bac8ec3297
Improving the documentation regarding the setup of anti spam measure (#1404)
Added a new section for antispam features, moved the HCAPTCHA_SITE_KEY there and added more informations on how to enable this feature
2024-02-19 20:15:18 +00:00
Michael Stanclift
615c19df56
Add Captcha configuration page (#1406)
* Add captcha page
* And warning to privacy block
2024-02-19 17:31:07 +00:00
Cassidy James Blaede
c03c080288
Profile: Mention 1MB response limit for verification (#1402)
Fixes #1401
2024-02-10 00:01:31 +00:00
Julia Evans
532bf4d9f0
Update documentation with Home feed visibility for replies (#1400)
* Update documentation with Home feed visibility for replies
* Add periods and remove contractions
2024-02-10 00:00:29 +00:00
Claire
894fb354f3
Fix incorrect property name streaming_api for the Instance entity (#1399)
The entity used for `/api/v2/instance` returns the streaming URL as `streaming`, not `streaming_api`.
2024-02-09 21:12:17 +00:00
David Baucum
b7f627cc67
Document the Onion-Location header in the Tor instructions (#901) 2024-01-25 16:47:21 +00:00
Michael Stanclift
65d67e1e41
Install Ruby 3.2.3 from rbenv (#1394) 2024-01-24 18:40:58 +01:00
Mubelotix
285f356e8c
Add documentation for some settings (#1382)
* Add documentation for some settings

---------

Co-authored-by: Andy Piper <andypiper@users.noreply.github.com>
2024-01-23 10:59:30 +00:00
a
5ef587184d
Fix typo in Admin::Cohort entity (#1392)
Fix type in Admin::Cohort entity
2024-01-23 10:02:10 +00:00
emmanuel
c145e063fa
Fix: Typo in documentation (#1379)
Few minor typos in documentation are corrected.
2024-01-14 00:35:04 +00:00
Mark Doliner
d53ab4f5e2
Small improvement to the TRUSTED_PROXY_IP docs. (#1145)
* Added a paragraph about how people can check whether Mastodon is seeing users' real IPs.
Co-authored-by: Michael Stanclift <mx@vmstan.com>
2024-01-13 22:34:10 +00:00
sgtatham
07b3bd95fc
Fix token type in account creation. (#1387) 2024-01-13 22:27:13 +00:00
Claire
6ddc3143f5
Add documentation for the severed_relationships event type (#1385)
* Add documentation for the `severed_relationships` event type
* Create RelationshipSeveranceEvent.md
2024-01-13 22:20:13 +00:00
Andy Piper
09ac07584a
Typos and language improvements. (#1362)
* Typos and language improvements.
* Table -> defn list per suggestion.
* clarify priority of queues

Signed-off-by: Andy Piper <andypiper@users.noreply.github.com>
Co-authored-by: Michael Stanclift <mx@vmstan.com>
2024-01-11 13:57:12 +00:00
a
fe380facfa
Fix http -> https (#1386) 2024-01-11 09:50:13 +01:00