Commit Graph

71 Commits

Author SHA1 Message Date
Jackson Chen 283f0c7c57
Fix dead link (#949) 2022-11-20 08:04:26 +01:00
A My Sour a1edb0ac40
Added text after a colon in install.md (there was none) (#957)
I'm guessing there was meant to be text there, so I added some to explain how to do it

Co-authored-by: Alex_Sour <52638772+Alex-Sour@users.noreply.github.com>
2022-11-20 08:03:43 +01:00
Matt Arcidy 61bcd7de89
Update install.md to use yarn version classic (#989)
`yarn set version stable` yields many install errors of Javascript packages.  note https://codesti.com/issue/mastodon/documentation/931.

Setting `yarn set version classic` works around these problems and the rest of the instructions work as indicated.  `classic` appears to be required.
2022-11-20 07:45:15 +01:00
ogelpre 12a1d3c0d9
Update firewall examples to fix PMTUD issues (#998)
According to RFC2979 Section 3.1.1 incoming ICMP Destination Unreachable / Fragmentation Needed errors MUST NOT be blocked.
2022-11-20 07:44:19 +01:00
Fil Maj ccd4389e86
Specify where to find Site Settings page (#1044) 2022-11-20 07:42:42 +01:00
Gervasio Marchand 6a157c2985
Update install instructions (#1052) 2022-11-20 07:41:21 +01:00
RealDekkia 7afa3e77c6
Added iptables-configuration for IPv6 (#1004)
The configuration is basically the same as with IPv4, but with some minor changes to make them work in IPv6.

Is it perfect? Probably not. But it's better than nothing.
2022-11-20 07:37:12 +01:00
Ash Kyd 1fa0b567db
Add ingress queue & update pull w Claire's help (#1050) 2022-11-20 07:35:23 +01:00
trwnh 3628b6d434
Update content for 4.0 (part 1) (#991)
* add rules

* join date on profiles

* deprecate follow scope

* deprecate identity proofs

* familiar followers

* use definition lists instead of tables for defining activitypub properties

* reformat notifications page into markdown

* fix broken links to publicKey header

* Application website is now nullable

* update environment variables added and removed

* fix typo

* fix heading level

* min_id and max_id can be used at the same time (3.3)

* fix typo

* new tootctl options

* reformat tootctl page to use definition lists for params

* add rules and configuration to Instance

* fix typo

* refactor instance api page

* 3.3.0 duration on mutes

* 3.3.0 mute_expires_at

* improve section headings

* 3.4.0 resend email confirmation api

* 3.4.0 policy on push subscriptions

* 3.4.0 add details to account registration error

* refactor accounts api page and start adding relrefs to entity pages

* 3.4.0 accounts/lookup api

* add see also to accounts methods

* add more see-also links

* 3.5.0 appeal mod decisions

* 3.5.0 reformat reports and add category/rule_ids params

* document report entity and missing responses

* fix typos

* fix relrefs and url schema, add aliases to old urls

* add archetypes for new methods/entities

* update archetypes with see-also stubs

* clearer presentation of rate limits

* announcements api methods

* refactor apps methods

* refactor bookmarks methods + some anchors

* refactor conversations methods

* custom_emojis methods refactor

* anchors

* refactor directory methods

* refactor domain_blocks methods

* add see also to emails methods

* fix page relref shortcodes to specific methods + refactor endorsements methods

* min_id max_id

* refactor favourites methods

* refactor featured_tags methods

* refactor filters methods, make path params consistent, i18n required shortcode

* follow_requests methods

* lists methods

* markers methods

* forgot to add entity links

* media methods, also fix formatting of some json errors

* mutes methods, add more see-also links

* oembed methods

* preferences methods

* proofs methods

* push methods

* suggestions methods

* 3.5.0 add new trend types, fix formatting

* refactor streaming methods

* refactor oauth methods

* note that streaming api casts payload to string

* refactor search methods

* refactor polls methods

* remove unnecessary link

* reformat scheduled_statuses methods

* reformat timelines methods

* reformat statuses methods

* 3.5.0 editing statuses

* consistent use of array brackets in form data parameters

* update dev setup guide, add vagrant and clean up text

* add admin/accounts methods

* 3.6 role entity

* admin/accounts methods v2

* minor fix

* stub admin/reports methods

* document admin reports

* add 403 example to methods archetype

* cleanup entities for admin reports and add new attrs

* 3.6.0 domain allows methods + normalize admin entity namespace

* fix search-and-replace error

* add aliases for admin entities

* 3.6.0 canonical email blocks entity

* 3.5.0 admin/retention api

* 3.5.0 add admin::ip doc

* 3.5.0 admin/reports

* 3.6.0 admin/domain_allows

* 3.5.0 admin/dimensions

* 3.6.0 permissions and roles

* minor formatting fix

* add anchor link to headings

* checkpoint

* add update commands to dev env setup guide

* change mentions of v3.6 to v4.0

* tootctl now uses custom roles

* fix formatting

* v2 instance api

* update frontmatter, add better titles to pages

* minor wording change

* consistency

* add more aliases

* add placeholders and WIP notices

* explain link pagination and stub out todos

* switch baseURL to https

* 422 on reports with rules but category!=violation

* document bug fixes

* fix typo

* remove duplicate API method definition

* s/tootsuite/mastodon for github links

* remove unnecessary escaping

* s/tootsuite/mastodon in Entity archetype

* add missing nullable shortcode

* clarify oauth scope when requesting a user token

* api/v2/media now synchronous for images

* DISALLOW_UNAUTHENTICATED_API_ACCESS

* add undocumented env variables

* add instance domain blocks and extended description api

* add SMTP_ENABLE_STARTTLS

* add description to SMTP_ENABLE_STARTTLS

* take suggestions from open PRs

* normalize links and flavour language

* Fully document streaming API based on source code

* Add mention of MIME types

* bump to ruby 3.0.4

* clarify how to check on async media processing

* validation of replies_policy

* remove TODOs on admin account action

* EmailDomainBlocks

* IpBlocks

* Admin::DomainBlock

* remove TODOs

* following hashtags

* followed_tags

* remove reference to unused parameter

* add new oauth scopes for admin blocks and allows

* fix command signature for i18n-tasks normalize

* reformat code structure page

* document fixes for following tags (assume 4.0.3)

* Add warning about pre-4.0 hardcoded roles

* add note about case sensitivity

* remove use of 'simply' from docs

* remove reference to silencing

* add reference to IDN normalization for verified links

* add lang parameter
2022-11-20 07:34:38 +01:00
rmacd 593d87d230
Admin -> Owner (per https://github.com/mastodon/documentation/pull/972#issuecomment-1304655676) (#974) 2022-11-05 23:59:41 +01:00
rmacd 8fe194b433
fix admin -> Admin (#972) 2022-11-05 17:28:00 +01:00
Elan Hasson d01250cc77
Use more inclusive language. (#971) 2022-11-05 03:39:59 +01:00
Stephen Yeargin b2f0baacdd
Adjusts role name examples to title case (#966) 2022-10-31 02:34:34 +01:00
nemobis fc99a82358
Rephrase ElasticSearch log4j warning, fix typos (#965)
Not sure whether it's still appropriate to direct people to a mitigation.
2022-10-30 11:57:34 +01:00
Luke Fisk-Lennon b881492350
Update Ubuntu version, add missing commands (#944) 2022-05-14 20:14:24 +02:00
Shlee 21716a766e
typo in RAILS_LOG_LEVEL (#933)
* Update config.md

* Update config.md
2022-05-04 02:56:49 +02:00
Showfom 2915445503
Update elasticsearch.md (#929)
- Update `openjdk-17-jre-headless` in Ubuntu 20.04 and Debian 11
- Update ElasticSearch to 7.x
- Add `systemctl daemon-reload` after installation

Tested and it's working fine.
2022-03-31 11:21:04 +02:00
Showfom 98d85c9f48
Update install.md (#927)
- Ubuntu 18.04 will be EOL on April, 2022. So I make changes for installation document with Ubuntu 20.04 and Debian 11 support.
- Added PostgreSQL with latest version (PostgreSQL 14)
- [Yarn](https://yarnpkg.com/getting-started/install) is now a default package since Node.js 16.10, there's no need to install yarn classic.
- From Mastodon [3.5.0](https://github.com/mastodon/mastodon/releases/tag/v3.5.0), ruby 3.0.3 is recommend.

Tested in Ubuntu 20.04 and Debian 11, all works fine.
2022-03-31 10:14:51 +02:00
JeremyStarTM 9e57382ba2
Modified two-liner into one-liner (#911) 2022-01-19 23:13:31 +01:00
Claire 090adf03fe
Improve warnings around the database maintenance script (#908)
* Improve warnings around the database maintenance script

* Fix repeated sentence
2022-01-16 17:03:38 +01:00
Claire d5d88f2c37
Add an info box about PgHero duplicate index warnings (#909)
Some people asked whether they should be running the maintenance script after seeing a PgHero warning about duplicate indexes.
This change highlights that the warning is unrelated to database index corruption.
2022-01-16 16:37:06 +01:00
Val Lorentz 1dc561d8e0
Fix package name for certbot-nginx (#910)
python-certbot-nginx does not exist anymore in Debian.
2022-01-15 19:26:31 +01:00
Holger de96f2a5d1
Add warning for log4j CVE-2021-44228 (#905) 2021-12-11 17:06:18 +01:00
Bruno Baguette 419b77f7b5
Typo fixes (#902)
- Typo fix : "duplicate" ➤ "duplicates"
- Typo fix : "chose" ➤ "choose"
- Typo fix : "occuring" ➤ "occurring"
2021-11-30 21:20:52 +01:00
Mashiro 9bea3ee51a
Add `--skip-sign-in-token` in admin CLI (#900)
* Update tootctl.md

* zh-cn
2021-10-26 15:12:16 +02:00
a sapphic bunne 2c00752228
Fixed 'AUTHORIZED_FETCH_MODE' typo in english (#891) 2021-09-13 18:29:52 +02:00
Bryce "BonzoESC" Kerley 55c284295f
point towards how to avoid index corruption (#893)
added links to the SQL `REINDEX` and CLI `reindexdb` commands
2021-08-29 18:00:20 +02:00
Kev Quirk b95d72be42
Updated individual moderation info to reflect new moderation options. (#865) 2021-05-06 02:27:15 +02:00
wiperS200 a4dc91ac03
Add pg_restore option (#874) 2021-05-06 02:26:36 +02:00
HolgerHuo 22ae9cabc7
Update scaling documentation to adapt to the new "scheduler" sidekiq queue (#875)
* Add scheduler sidekiq queues as the code updates

* 更新sidekiq队列以适应文档

* Update scaling.md

* Update scaling.md
2021-05-05 14:16:45 +02:00
Claire dfeb299d4d
Improve WEB_DOMAIN documentation (#817)
* Improve WEB_DOMAIN documentation

Explain that queries to the webfinger endpoint on the WEB_DOMAIN have to be proxied/redirected to the LOCAL_DOMAIN.

* Improve wording based on suggestions

Co-authored-by: Raphael Schweikert <any@sabberworm.com>

* Improve documentation for LOCAL_DOMAIN and WEB_DOMAIN

- Concisely explain why it cannot be changed later, stressing this isn't about your install but about remote servers.
- Add an example relating `LOCAL_DOMAIN` and `WEB_DOMAIN` to avoid confusion.
- Make it explicit that the value is optional.

Co-authored-by: Raphael Schweikert <any@sabberworm.com>
2021-04-22 18:45:08 +02:00
teutates 9e6a65d55f
Fix typo (#870) 2021-04-07 20:14:02 +02:00
Eugen Rochko dbfc97e682
Revert "Slight improvements for admin docs (#856)" (#861)
This reverts commit 9beb501bac.
2021-03-04 04:16:02 +01:00
Noah H 063feeaf3b
update version history and options for `tootctl search deploy` (#859) 2021-02-15 18:14:51 +01:00
Janek 9beb501bac
Slight improvements for admin docs (#856)
* admin/install: simplify system package instructions & use sh codeblocks

No need to assume bash

* admin/config: document RAILS_ENV in more detail
2021-01-24 09:52:33 +01:00
Janek c831e1c1cf
Simplify systemd section in install.md (#851) 2021-01-16 14:58:17 +01:00
Eugen Rochko c549ff298f
Revert "Revert "Update, we need to install Ruby 2.7.2 (#829)" (#830)" (#844)
This reverts commit 84ac3d711c.
2021-01-07 20:19:53 +01:00
trwnh bcf77cb795
3.3.0rc2 (#834)
* add identifier for troubleshooting pages

* mention mutes can be temporary now

* bell for notifications

* convert images to jpg and rename them

* suspensions now reversible

* unread notifications

* suspended: true

* mutes expiry

* replies_policy, type of notification

* notify

* featuredTags AP representation

* new env vars

* accounts merge

* maintenance cli

* list replies

* suspended flag

* follower sync

* minor formatting

* add note about idempotency of follow action

* account featured tags, min_id and max_id, plus normalization

* follow marcin and nightpool's suggestion

* bearcaps

* replies_policy update

* featuredtags now have a url
2020-12-27 07:03:55 +01:00
ThibG 7df49f31a1
Add more detailed instructions regarding index corruption (#835)
- emphasizes that Mastodon has to be stopped when running the script
- add `RAILS_ENV=production` in front of the `tootctl` line as it is a common mistake to run it without `RAILS_ENV` set
- mention 3.2.2 as the first release shipping the script (assuming that will be the case)
2020-12-18 17:53:35 +01:00
trwnh 3bd141f65e
add identifier for troubleshooting pages (#833) 2020-12-08 00:09:21 +01:00
Eugen Rochko 84ac3d711c
Revert "Update, we need to install Ruby 2.7.2 (#829)" (#830)
This reverts commit dbf078733f.
2020-11-30 23:02:07 +01:00
Marcin Mikołajczak dbf078733f
Update, we need to install Ruby 2.7.2 (#829) 2020-11-30 05:46:55 +01:00
ThibG 13cb6106fc
Add documentation about index corruption (#811)
* [WiP] Add documentation about index corruption

Add documentation about index corruption caused by changes in collation rules, and information on how to fix it.

* Add doc on how to check indexes

Add documentation on how to check indexes without bringing the instance down.

* Update index-corruption.md

* fixup typo

* Add instructions for re-creating the database

* Add minor explanations

* Remove recommendation to re-create database with C collation

Meaningful case-folding operations are used within the database for hashtags, so do not recommend using `C`, which would cause issues with non-ASCII hashtags.
2020-11-19 21:49:18 +01:00
koyu 074aafcc64
Update dependencies (#820) 2020-10-17 15:32:54 +02:00
Y.Yamashiro 64607d49e1
Change S3 access style (#799) 2020-09-28 05:10:25 +02:00
Nolan Lawson 3811ae1068
fix: fix incorrect link to `upgrade_cli.rb` (#814)
Looks like this was copypasted from the previous link.
2020-09-28 05:03:14 +02:00
Nolan Lawson 4617ea900a
feat: add a section on periodic cleanup tasks (#816)
* feat: add a section on periodic cleanup tasks

I asked in Discord today about which `tootctl` tasks are good to run on a regular basis (as there are a lot of cleanup jobs). It seems that `media remove` and `preview_cards remove` are the standard ones that you want to run on a regular basis (e.g. with cron). So I added this to the docs in its own section, under "Things to do after installing Mastodon."

* fix: fix typo
2020-09-28 04:58:09 +02:00
KT f36d1f9b58
Add DB_SSLMODE to config page (#812)
* Add DB_SSLMODE to config page

* Add DB_SSLMODE for zh-cn
2020-09-23 19:37:10 +02:00
Eugen Rochko 3375a76538 Add documentation on how to proxy S3 through nginx 2020-07-26 23:45:00 +02:00
Eugen Rochko 1b2f466db1 Fix ElasticSearch documentation 2020-07-26 22:55:38 +02:00