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

176 Commits

Author SHA1 Message Date
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
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
Andy Piper
09dc6a85cd
e-mail -> email in most documentation references. (#1365) 2024-11-22 16:33:04 +00: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
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
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
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
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
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
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
Michael Stanclift
2dfcf2c059
Add config for MASTODON_USE_LIBVIPS (#1463)
* Docs for using libvips

* "utilizating"
2024-08-26 10:40:37 +02:00
Renaud Chaput
8d67de74f9
Add OTEL configuration, and deprecate StatsD (#1518) 2024-08-23 16:02:37 +02:00
Michael
336b597506
Update Ubuntu requirements (#1486) 2024-08-01 16:25:08 +01:00
Thomas Hansen
04a9453da4
Update install.md (#1469)
Fix ruby-build install command
2024-07-12 15:35:51 +01: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
Val Lorentz
9294788aaa
tootctl search deploy: Document changes since v3.5.0 (#1454) 2024-06-11 11:25:14 +01: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
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
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
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
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
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
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
Renaud Chaput
38c4b995a0
Add documentation for cache buster and hcaptcha (#1383) 2024-01-09 15:01:34 +01:00
Renaud Chaput
a6528ba511
Update documentation for read-only replica (#1384) 2024-01-09 14:38:50 +01:00
Andreas Wittig
4eb8473e62
Adding S3_PERMISSION environment variable (#1155)
* Adding S3_PERMISSION environment variable
* Update content/en/admin/config.md

Co-authored-by: Michael Stanclift <mx@vmstan.com>
2024-01-07 22:23:55 +00:00
Travis Briggs
ec5ea76a44
Update admin install instructions for node 20 (#1340)
* Update admin install instructions for node 18 (min version for 4.2.1)

* Remove apt-get from node instructions and actually install it in the apt command below

* Remove remaining sudo and put key in same location as postregsql key

* Update content/en/admin/install.md

Co-authored-by: tibequadorian <9560587+tibequadorian@users.noreply.github.com>

---------

Co-authored-by: tibequadorian <9560587+tibequadorian@users.noreply.github.com>
2023-12-27 12:51:35 +01:00
Panagiotis "Ivory" Vasilopoulos
63edbbad2e
Improve Tor documentation (#937)
* Improve Tor documentation
Co-authored-by: Michael Stanclift <mx@vmstan.com>
2023-12-15 21:23:18 +00:00
Andy Piper
759c0e8bbd
Revert "Add basic Redis Sentinel documentation" (#1370)
Revert "Add basic Redis Sentinel documentation (#1311)"

This reverts commit 3712250ef255caf6354eb176872b20584e375e1f.
2023-12-12 10:31:54 +01:00
Gabriel Simmer
3712250ef2
Add basic Redis Sentinel documentation (#1311)
* Add basic Redis Sentinel documentation

Co-authored-by: Andy Piper <andypiper@users.noreply.github.com>
2023-12-11 22:49:25 +00:00
Michael Stanclift
a625f3f60e
Remove nginx default site (#1367)
* remove default site
* fix default in migration guide
2023-12-11 22:46:07 +00:00