Commit Graph

278 Commits

Author SHA1 Message Date
Leon Kowalski 0dc4745593
Fix `force_login` type & more (#894)
* Fix `force_login` type & more

Makes `force_login` of type `bool` & moves optional parameters to bottom of table for consistency.

* Fix `limit` type & provide descriptions

* Fix typo
2021-09-13 17:55:48 +02:00
Claire 06cc977ff1
Deprecate the text_url attribute to media attachments (#895) 2021-09-13 17:55:19 +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
WammKD 599fd67b1e
Update libraries.md (#881)
Add a library for Guile Scheme.
2021-05-29 22:43:41 +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
Justin Mazzocchi 62711e29d4
Add metatext-apns to list of push relay services (#864) 2021-03-18 05:48:58 +01: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
Marcin Mikołajczak 8fa91d1719
Polish translation (#832)
* Polish translataion WIP

Signed-off-by: mkljczk <me@mkljczk.pl>

* Polish translation WIP

Signed-off-by: mkljczk <me@mkljczk.pl>

* Polish translation WIP

Signed-off-by: mkljczk <me@mkljczk.pl>

* Polish translation WIP

Signed-off-by: mkljczk <me@mkljczk.pl>

* Polish translation WIP

Signed-off-by: mkljczk <me@mkljczk.pl>

* Polish translation WIP

Signed-off-by: mkljczk <me@mkljczk.pl>

* Polish translation WIP

Signed-off-by: mkljczk <me@mkljczk.pl>

* Polish translation WIP

Signed-off-by: mkljczk <me@mkljczk.pl>

* Polish translation WIP

Signed-off-by: mkljczk <me@mkljczk.pl>

* Polish translation WIP

Signed-off-by: mkljczk <me@mkljczk.pl>

* Polish translation WIP

Lots of spelling corrections

* Polish translation WIP

* Polish translation WIP

* Polish translation WIP

actually I just want to sync between my Windows and Linux installation

* Create FUNDING.yml

* Polish translation WIP

* Revert "Create FUNDING.yml"

This reverts commit c106424163.

* Polish translation WIP

* Applied suggestions by @selfisekai

Signed-off-by: mkljczk <me@mkljczk.pl>

* Update config.toml

Co-authored-by: Hexandcube <mikolajzaremba03@gmail.com>

* Update content/pl/user/run-your-own.md

Co-authored-by: Hexandcube <mikolajzaremba03@gmail.com>

* Update content/pl/user/signup.md

Co-authored-by: Hexandcube <mikolajzaremba03@gmail.com>

* Update content/pl/user/run-your-own.md

Co-authored-by: Hexandcube <mikolajzaremba03@gmail.com>

* Update content/pl/user/run-your-own.md

Co-authored-by: Hexandcube <mikolajzaremba03@gmail.com>

* Apply suggestions by @hexandcube + minor changes

Signed-off-by: mkljczk <me@mkljczk.pl>

* Apply suggestions by @hexandcube + minor changes

Signed-off-by: mkljczk <me@mkljczk.pl>

* Polish translation: Reflect changes from #834

* Fix typo in English version

* pl: Remove broken link to Nablahost

* pl: Use fictitious domain in blocking example (

* Polish translation: Fix images

Signed-off-by: marcin mikołajczak <me@mkljczk.pl>

Co-authored-by: Hexandcube <mikolajzaremba03@gmail.com>
2021-01-20 01:19:19 +01:00
Janek c831e1c1cf
Simplify systemd section in install.md (#851) 2021-01-16 14:58:17 +01:00
Benoît Verret dfda363212
Fix block-domain.png not appearing (#849)
Resize block-domain.png as it didn't work with ` | height=200`.
2021-01-13 14:27:35 +01:00
Sjors Provoost 29cb04b2ea
Use fictitious domain in blocking example (#848) 2021-01-12 13:31:36 +01:00
Joe e433b233b9
Remove broken link to Nablahost (#845)
I couldn't find any information online about what happened to them, but [their domain](http://nablahost.com/) expired and is now owned by a domain squatter.
2021-01-09 07:43:50 +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
Mélanie Chauvel 15cdc0d09a
Mention that filters targetting home timeline also affects lists (#828) 2020-11-26 01:48:32 +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
Eugen Rochko 34fab9a9ff
Add note about secure mode in ActivityPub document
Fix #822
2020-10-24 22:07:22 +02:00
koyu 31a159d456
Add pre-requisites instructions for dev setup (#821) 2020-10-17 15:33:34 +02: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 1124632417
fix: explain Postgres error when creating a dev environment (#815)
This has tripped me up a few times, so having this in the documentation would save me a Google search. 🙂
2020-09-28 05:03:37 +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
Justin Mazzocchi f3bc8f5699
Fix filter expiry parameter type documentation (#806) 2020-08-30 02:40:46 +02:00
James Valleroy da50b5192e
Make JSON example use valid JSON (#804) 2020-08-24 01:26:17 +02:00
Moritz 1148f0415b
Fix typo in filename introduced in #801 (#802) 2020-08-11 02:14:13 +02:00
Moritz 5ebc8ad418
Replace and fix broken links with hugos relref (#801)
As discussed in #764 there are quite a lot of outdated links in the
mastodon documentation. In basically all cases this was resolved by
simply wrapping the old plain markdown link in hugos `relref`
function[^0].

While quite a lot of links on the `/zh-cn/` also appear to be broken,
these can not be fixed by just wrapping them in `relref`[^0]. Those are
all links to `/spec/` subpages which are just not translated to `/zh-cn/`
version. Therefore, `/zh-cn/spec/` has been excluded from the automated
checking as described in the next section.

The page has been checked using the linkchecker[^1] utility. One process
is running `hugo serve` in order to see all changes in real time and
notice errors directly in your browser. In a separate command prompt the
command `linkchecker http://localhost:1313 --ignore-url=/zh-cn/spec` is
being fired up. Note the `--ignore-url=/zh-cn/spe` to exclude the just
not existing parts of the page as mentioned in the previous paragraph.

There still is some ToDo on the table since quite a lot of the anchors
appear to not be set or at least differ from previous versions. One
example: on `/client/authorized/` is a link to
`/client/token/#creating-our-application` while the id of referenced
heading is `app`. These changes **do not** fix those Issues as it would
require way more time.

[^0]: https://gohugo.io/functions/relref/
[^1]: https://github.com/linkchecker/linkchecker

Close #764
2020-08-10 23:01:50 +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
Eugen Rochko 9a756a0947 Write out more documentation 2020-07-26 01:46:40 +02:00
Eugen Rochko 56a2e068ce Add more documentation 2020-07-25 18:04:22 +02:00
Eugen Rochko 75e9f9585a Add more configuration documentation 2020-07-25 17:51:43 +02:00
trwnh 00277c3e36
3.2.0rc1 (#795)
* add blurhash to card entity

* update tootctl

* env vars

* local/web domain

* revert http_proxy
2020-07-25 16:35:41 +02:00
Karissa McKelvey 35b4d2d280
fix: systemctl enable mastodon-* does not always work (#794)
root@ubuntu:~# systemctl enable mastodon-*
Failed to enable unit: Unit file mastodon-\x2a.service does not exist.
root@ubuntu:~# systemctl enable mastodon-web mastodon-sidekiq mastodon-streaming
Created symlink /etc/systemd/system/multi-user.target.wants/mastodon-web.service → /etc/systemd/system/mastodon-web.service.
Created symlink /etc/systemd/system/multi-user.target.wants/mastodon-sidekiq.service → /etc/systemd/system/mastodon-sidekiq.service.
Created symlink /etc/systemd/system/multi-user.target.wants/mastodon-streaming.service → /etc/systemd/system/mastodon-streaming.service.
2020-07-15 17:56:37 +02:00
trwnh 864610c67e
user notes and custom thumbnails (#792)
* AnnouncementReactions and examples

* add `note` to Relationship entity

* normalize entity filenames

* add user note to api

* add user note to api

* add thumbnail param to media api

* add icon as thumbnail
2020-07-10 12:28:00 +02:00
trwnh dc87541c92
AnnouncementReactions and examples (#789) 2020-07-03 13:35:55 +02:00
umonaca cfc0225a91
Further improve troubleshooting page (#788)
* Further improve troubleshooting

* Update troubleshooting.md
2020-07-03 02:23:31 +02:00
trwnh e6d563b695
fix #767 (#787) 2020-07-01 11:18:05 +02:00
trwnh 5e36f51109
update for 3.1.4 (#786)
* update for 3.1

* 3.1.2

* 3.1.3

* 3.1.4
2020-07-01 03:13:20 +02:00
trwnh 17143bad72
update for 3.1 (#785) 2020-07-01 02:11:40 +02:00
umonaca 5680e44983
Add troubleshooting for compilation error (#782)
* Add troubleshooting item

* Minor changes
2020-06-30 13:17:04 +02:00
ujjwal123123 0f8951c40d
Change json.dumps to json.loads (#774)
`json.dumps` converts JSON to Python string which is not what's needed here. If `json.dumps` is used, `statuses[0]` becomes `"`.
2020-06-20 14:01:35 +02:00
Clayton Hadley 56f3518b29
Update overview.md (#780)
added clarification on where to find more information on setting up a dev environment
2020-06-20 13:56:56 +02:00
trwnh cbb1232b73
fix broken anchors (#773) 2020-06-08 00:55:32 +02:00
yingziwu b6e011265d
Add chinese translation (#772)
* add chinese config and i18n

* Import translation from https://bitbucket.org/mastodoncn/mastodon-zh-cn/src/master/

* translate Using Mastodon

* Translate Running Mastodon
Add Chinese search optimization
Fix some bugs

* substitute 长毛象 to Mastodon

* do some modifications.
2020-05-20 20:54:12 +02:00
trwnh 02839e07ce
fix copy-paste error (#771)
streaming should be nested under timelines
2020-05-06 13:13:42 +02:00
Eugen Rochko ad1ef20f17 Add bug bounty page 2020-04-29 14:54:04 +02:00
Eugen Rochko 729dd1956f Add warning 2020-04-23 18:40:14 +02:00
Eugen Rochko 738c297d5c Add "Running your own server" page 2020-04-22 23:25:08 +02:00
Lerk bd38c1a487
Fix bundle config commands (#766) 2020-04-21 22:09:55 +02:00
Eugen Rochko 2cfe57c426 Update Ruby 2020-04-05 17:11:06 +02:00
GroovinChip 818560fbd4
Update libraries.md (#760)
Add Dart API library
2020-03-19 18:21:05 +01:00
Eugen Rochko 59055006c9 Add information about rate limits 2020-03-05 22:33:10 +01:00
Eugen Rochko f06c38fd1e Improve the upgrade page 2020-02-28 14:27:39 +01:00
Bei Li 5465fcdeab
Update status.md (#757)
* Update status.md

* Update status.md

* Update status.md

* Update status.md

* Update status.md

* Update status.md

* Update status.md

* Update status.md
2020-02-20 17:55:04 +01:00
BSKY bddd59a36a
Bump version of Node.js to install (#759) 2020-02-20 17:54:48 +01:00
trwnh 402a44cdbb
Move client-dev page out of user guide (#756) 2020-02-16 12:57:50 +01:00
Даниил Пронин 9858688afe
Update Node version in install.md (#753) 2020-02-09 01:02:46 +01:00
rinpatch 5888c426ac
Account Entity: correct `note` type (#751) 2020-01-30 17:26:34 +01:00
Frinkeldoodle ff2cdcc716 Add missing command to export key from gpg to apt (#748) 2020-01-22 20:07:14 +01:00
ThibG ae93e4b66d Document AUTHORIZED_FETCH and WHITELIST_MODE (#750)
* Document AUTHORIZED_FETCH and WHITELIST_MODE

* Make headings out of the documented env variables
2020-01-22 20:01:37 +01:00
Jack Laxson 97d36a47af fix up the links not working on this page (#749) 2020-01-19 11:15:41 +01:00
tastytea 53f39f031d Libraries: Replace mastodon-cpp with mastodonpp. (#746)
mastodon-cpp is not actively maintained anymore and has been replaced by
mastodonpp.
2020-01-12 14:12:45 +01:00
trwnh 7ceae9fe36 Update anchors, line breaks, tootctl options (#745)
* update anchors

* remove extraneous anchors

* fix line breaks

* wrap tootctl tokens in code blocks

* change anchors to hugo format

* fix mistaken search-and-replace

* fix mistaken search-and-replace
2020-01-12 14:11:56 +01:00
trwnh 32d4dd5803 add remote_only emoji purge to tootctl (#744) 2020-01-10 10:05:00 +01:00
QuietMisdreavus aa9cc59f95 tweak install.md for completeness (#742) 2020-01-07 02:30:05 +01:00
Eugen Rochko 50ef0a4bf7 Make the layout wider 2020-01-05 20:08:58 +01:00
Eugen Rochko 33cb69ad07 Update documentation with contents by twrnh 2020-01-04 10:33:16 +01:00
Daniel Nitsikopoulos 9c543075e0 Update entities.md with poll notification type 2019-07-26 07:47:03 +02:00
Eugen Rochko eeadacaadd Merge branch 'master' into 'master'
Add documentation about the state parameter

See merge request mastodon/docs!46
2019-07-08 21:24:22 +02:00
Eugen Rochko 38f8e77a91 Update content/en/api/rest/notifications.md 2019-07-08 21:22:31 +02:00
fluffy 07d8e93d9b Add documentation about the state parameter 2019-07-08 11:09:12 -07:00
Eugen Rochko 09004146f5 Update content/en/api/entities.md 2019-06-14 15:32:36 +02:00
Eugen Rochko 2fe355ce83 Merge branch 'patch-1' into 'master'
Update notifications.md to include `from_account`

See merge request mastodon/docs!41
2019-06-11 16:45:37 +02:00
Eugen Rochko bcff8d180d Update notifications.md 2019-06-11 16:45:23 +02:00
Eugen Rochko 74699dd151 Merge branch 'patch-3' into 'master'
Update notifications.md to mention polls in push subscriptions

See merge request mastodon/docs!42
2019-06-11 16:44:02 +02:00
Eugen Rochko d9492aee6b Merge branch 'patch-1' into 'master'
Because mastodon:setup isn't run, we need to compile manually

See merge request mastodon/docs!43
2019-06-11 16:43:49 +02:00
kjwon15 54e99c894d Add description about "streaming health" endpoint 2019-06-03 16:20:36 +09:00
jeroenpraat 5bcad665cd Because mastodon:setup isn't run, we need to compile 2019-05-30 22:45:11 +02:00
Nolan Lawson 7576c4122f Update notifications.md to mention polls in push subscriptions 2019-05-28 04:51:48 +02:00
Paul Woolcock 04768e73ee Change parameter name to `account_id` 2019-05-21 09:12:08 -04:00
Paul 7cf6355ba7 Update notifications.md to include `from_account`
This PR is dependent on another PR getting merged: https://github.com/tootsuite/mastodon/pull/10796 . If that PR is not accepted, this can also be closed
2019-05-20 17:52:31 +02:00
Eugen Rochko fc3a976a04 Merge branch 'patch-1' into 'master'
Fixed link to Context in entity Filter.

See merge request mastodon/docs!39
2019-05-19 11:10:46 +02:00
Justin 5eecce6a64 Correct typo in decentralization.md 2019-05-15 09:44:21 +02:00
tastytea 8cb8028763 Update entities.md 2019-05-12 17:25:25 +02:00
Eugen Rochko 6ea5528824 Merge branch 'patch-1' into 'master'
Update installation.md to Ruby 2.6.1 to fix https://github.com/tootsuite/mastodon/issues/10105

See merge request mastodon/docs!27
2019-05-09 23:12:50 +02:00
Eugen Rochko 59081b71e2 Merge branch 'master' into 'master'
Improved documentation for running Mastodon as a Tor service

See merge request mastodon/docs!31
2019-05-09 23:12:38 +02:00
Eugen Rochko 7929127a70 Merge branch 'masto-js' into 'master'
Add yet another JS API library

See merge request mastodon/docs!34
2019-05-09 23:10:23 +02:00
Eugen Rochko f0c595004b Merge branch 'patch-1' into 'master'
Update installation.md to use certbot --nginx instead of --webroot

See merge request mastodon/docs!37
2019-05-09 23:09:59 +02:00