Commit Graph

351 Commits

Author SHA1 Message Date
Chee Aun 4ee33a54b5
Fix typo s/statuses/accounts (#1196) 2023-04-07 09:01:21 +02:00
aaaaalbert 5b1f92c203
Fix markdown figure formatting leftovers in the English docs (#1195)
* Convert left over Markdown figures to Hugo

Also add captions for the respective figures: profile.jpg, bell.jpg, and lists.jpg

* Convert another left over Markdown figure to Hugo

Also add a caption for the figure: bot-flag.jpg
2023-04-04 10:44:41 +02:00
Thomas Soubrier 46cbbc6d73
Update object-storage-proxy.md (#1056)
This documentation has I believe one very confusing point: It uses two times `YOUR_S3_HOSTNAME` in the nginx configuration example, however the second time it looks like you actually have to use `YOUR_BUCKET_NAME.YOUR_S3_HOSTNAME`.

## Explanation
Mastodon is using path-style requests to S3 which looks like this:
https://s3.region-code.amazonaws.com/bucket-name/key-name

Once you enable the new virtual host nginx file using the current indications, the path-style request which goes to amazon looks like this:
https://s3.region-code.amazonaws.com/key-name

In other words, the bucket name is not being sent S3 and the images break.

This is because the current instructions make it seem like the header Host name is not including the bucket
`proxy_set_header Host YOUR_S3_HOSTNAME;`

With the current path-style request integration, one must use the bucket name in the Host header for this to work, hence the proposed change to

`proxy_set_header Host YOUR_BUCKET_NAME.YOUR_S3_HOSTNAME;`
2023-03-29 10:52:31 +02:00
Vyr Cossont ad28620313
Update Role docs to remove attrs that aren't serialized (#1188)
Also added more realistic example permissions for the Owner role
2023-03-20 20:05:24 +01:00
remove 9fd09540cb
Fix `assets/block-domain.png` figure. (#1166) 2023-03-17 09:47:32 +01:00
Claire 724d4bb1d7
Add documentation for object storage providers (#1186) 2023-03-16 22:19:03 +01:00
Anders Eknert e3b5391784
Relationships: example POST request should be GET (#1176) 2023-03-08 17:40:38 +01:00
Isa S 59aa5f047a
Correct links to the main mastodon repo (master --> main) (#1173)
* Fix links to mastodon repo

* Use preferred language
2023-03-08 17:40:02 +01:00
Vyr Cossont 5e82c71542
Remove references to nonexistent Mastodon 3.6 in filter docs (#1167) 2023-03-08 17:39:05 +01:00
Josh Soref 6be1e702bd
Spelling (#1163)
* spelling: conversion

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* spelling: translation

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

---------

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
2023-03-08 17:38:51 +01:00
trwnh b458498d25
Miscellaneous fixes (#1110)
* Fix typos in method examples

* Fix broken link to sanitize_config (#1115)

* Add SIDEKIQ_CONCURRENCY

* Fix relref to FilterResult (#1114)

* Fix status_ids and rule_ids description (#1126)

* fix typo (#1129)

* clarify confusing example (mastodon/mastodon#22854)

* fix formatting on linked headings (#1139)

* fix placeholder entity names (#1157)

* better wording

* fix scheduledstatus#params.visibility

* fix missing: tootctl accounts modify --remove-role

* add: status/translate

* add deprecation/removal warning to microformats page

* clarify further how link verification works

* clarify mastodon requirements for webfinger

* fix: push param policy -> data[policy]
2023-02-07 02:14:07 +01:00
nightpool 5b0cd8b7f0
Document requirement for `updated` timestamp on statuses when processing Update (#1150)
After discussion with a new implementer here https://socialhub.activitypub.rocks/t/what-could-be-the-reason-that-my-update-activity-does-not-work/2893, I realized that we don't currently document the need for an `updated` property when processing Update activities. This PR documents that requirement and adds some details about why it exists.
2023-01-16 17:36:21 +01:00
Mark Doliner 17a5e151a5
Improve documentation for TRUSTED_PROXY_IP (#1144)
* Improve documentation for TRUSTED_PROXY_IP

The documentation previously only indicated that `localhost` was trusted, but it appears that all private networks are trusted by default. I believe this because:

- I'm running my web and streaming processes within Docker containers and running Nginx on the Docker host. I believe they communicate over a 172.16.0.0/12 network that Docker creates. I tried looking at logs a bit and it _seems_ like things are working correctly. But if anyone has suggestions on how to verify that my Mastodon processes are recording the correct client IP, please let me know! We could include that advice in this documentation.
- I looked at the source code a bit and it appears that both the streaming and web processes use localhost and the private network ranges. But this is really my first time looking at the Mastodon code and I don't even know Ruby, so please double check me!
  - I believe the streaming processes uses Express JS. I believe it sets the trusted proxy IP [here](d11d15748c/streaming/index.js (L150)). Express documents the `loopback` and `uniquelocal` values [here](https://expressjs.com/en/guide/behind-proxies.html).
  - I'm less certain about web. It looks like the env var is parsed [here](d11d15748c/config/environments/production.rb (L44-L45)). It looks like `trusted_proxies` will be unset if the env var is unset. And maybe that results in [this check](https://github.com/mastodon/mastodon/blob/main/config/initializers/trusted_proxies.rb) getting bypassed? But it looks like Action Dispatch does it's own check [here](https://api.rubyonrails.org/classes/ActionDispatch/RemoteIp.html)?

* Try to improve the phrasing

Specifically I tried to make it less likely that people would do the wrong thing if they're using Cloudflare or a similar proxy service. It does seem pretty wordy now. I'm open to suggestions.
2023-01-06 07:54:14 +01:00
Renaud Chaput 0b183dff3a
Deploy to Github Pages (#1138) 2022-12-30 21:54:01 +01:00
Renaud Chaput d356c6caac
Switch hosting to Vercel (#1113)
* Fix URLs to work when `baseURL` is in a sub-directory

* Use `RelPermalink` to not have assets loaded from `baseUrl`

* Add `.vercel` to gitignore

* Remove deploy Github Action, we are now using Vercel
2022-12-21 06:26:37 +01:00
trwnh ffbe66a389
Update content for 4.0, part 2 (#1060)
* fix relrefs around trends and related entities

* revert moving caption-links to middle of page

* hide empty menu in table of contents

* clarify edit notifs are only for boosted statuses

* following/followers no longer need auth

* fix typo

* specify cooldown period for account Move

* use the correct cooldown

* add missing parameters to accounts/id/statuses

* link to account_statuses_filter.rb

* fix typo (#1072)

* fix typo (#1073)

* fix link to http sig spec (#1067)

* simply HTTP request examples in api methods docs

* add missing client_secret to oauth/token (#1062)

* Add any, all, none to hashtag timeline

* minor formatting changes

* Update signature requirements and advice

* fix public key -> private key

* clarify use of RSA with SHA256

* Add note about saving your profile after adding rel-me link

* v2 filters api

* comment out params that shouldn't be used in v2 filter api

* admin trends

* remove old todo

* canonical email blocks + scheduled statuses

* remove under-construction warnings from finished pages

* verify api method params with source code

* fix typo (#1088)

* fix broken caption-links (#1100)

* fix formatting of entities (#1094)

* Remove keybase section from user guide (#1093)

* fix typos (#1092)

* Verify limits are accurate (#1086)

* add mention of iframe limitation (#1084)

* Add CORS header to WEB_DOMAIN example (#1083)

* Fix typo (#1081)

* pin http sigs spec at draft 8

* Revert "pin http sigs spec at draft 8"

This reverts commit 9fd5f7032b.

* add case sensitivity warning to 4.0 roles

* Add url length note to bio (#1087)

* remove follow scope from examples (#1103)

* clarify usage of update_credentials to update profile fields

* add noindex to Account entitity

* remove required hint from technically not required property
2022-12-14 22:55:30 +01:00
Eugen Rochko 1dad33b87b Fix image 2022-11-21 02:16:14 +01:00
Eugen Rochko cac42eff20 Update sponsors 2022-11-21 00:02:38 +01:00
Andre_601 3f6b23b3ce
Add links to sub-pages for optional stuff (#1013) 2022-11-20 08:12:08 +01:00
nemobis 60d552157e
Fix typo in config.md (#932) 2022-11-20 08:05:24 +01:00
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
Oliver Hengstenberg bc652cadc4
Update intro.md (#960)
Add json.org reference link to the JSON chapter
2022-11-20 08:02:49 +01:00
Kevin Moore d91c6b624e
Replace Dart package that was discontinued... (#970)
...with a more actively maintained package
2022-11-20 07:48:22 +01:00
Jakob Gillich c1a15217c4
Add Cloudplane to hosting providers (#986) 2022-11-20 07:48:00 +01:00
Andrew Seigner eb8b35c032
Bump Hugo from `0.62.1` to `0.105.0` (#982)
Fixes #967
2022-11-20 07:47:05 +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
Precision Wordcraft LLC 2676efdb86
Update preferences.md (#1045)
Clarify what "posting defaults" means and make it more likely that users will find these settings with a search.
2022-11-20 07:42:00 +01:00
Precision Wordcraft LLC 9673ed09d5
Update posting.md (#1046)
Added instructions on how to set default post privacy, and added more detail on how to change privacy for any one post.
2022-11-20 07:41:46 +01:00
Gervasio Marchand 6a157c2985
Update install instructions (#1052) 2022-11-20 07:41:21 +01:00
KD Puvvadi b3a4043ffa
Correct ruby version to 3.0.4 (#1030)
https://github.com/mastodon/mastodon/blob/main/.ruby-version
https://github.com/mastodon/mastodon/pull/18028
2022-11-20 07:40:45 +01:00
Terence Eden 5091aebd12
Remove dead PHP link (#1012) 2022-11-20 07:38:56 +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
Tatham Oddie 69e9017730
Fix broken markup (#1025)
Missing closing double quote
2022-11-16 03:44:42 +01:00
Tatham Oddie d108182d82
Add HTTPS requirement for link verification (#1022)
Brings documentation in line with new constraints introduced by https://github.com/mastodon/mastodon/issues/20242
2022-11-16 00:24:25 +01:00
Lim Ding Wen b817492314
Add fedi.monster to hosting providers (#980) 2022-11-07 22:38:21 +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
Eugen Rochko 92d282846a Add new sponsors 2022-11-05 22:39:37 +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
Markus Weingärtner ba52f05dfc
Update Hosting Providers (#954)
Added Weingärtner IT
2022-10-31 16:33:05 +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
Eugen Rochko 9030ad9e89 Fix forgotten import 2022-10-23 23:59:48 +02:00
Eugen Rochko 10f2068f40 Fix fonts 2022-10-23 23:57:54 +02:00
Sam Wilson d1f47a9d2d
Remove yks118/Mastodon-api-php from the PHP section (#958)
Per https://github.com/yks118/Mastodon-api-php/issues/4 that library is no longer maintained.
2022-08-28 14:39:12 +02:00