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
This commit is contained in:
trwnh
GitHub
parent
69e9017730
commit
3628b6d434
225 changed files with 22675 additions and 11631 deletions
|
|
@ -23,9 +23,9 @@ You can choose to feature profiles of people that you are following. Go to that
|
|||
|
||||
## Pinned posts {#pinned}
|
||||
|
||||
{{< figure src="/assets/pinned.jpg" caption="A pinned toot by mastodon.social/@gargron" >}}
|
||||
{{< figure src="/assets/pinned.jpg" caption="A pinned post by mastodon.social/@gargron" >}}
|
||||
|
||||
You can choose to feature up to 5 of your own public posts at the top of your profile. Go to the status dropdown menu and click "Pin on profile". When you pin a toot, it will appear at the top of your "toots" tab, before all other chronological status updates.
|
||||
You can choose to feature up to 5 of your own public posts at the top of your profile. Go to the status dropdown menu and click "Pin on profile". When you pin a post, it will appear at the top of your "posts" tab, before all other chronological status updates.
|
||||
|
||||
## Profile directory {#directory}
|
||||
|
||||
|
|
@ -33,7 +33,7 @@ You can choose to feature up to 5 of your own public posts at the top of your pr
|
|||
|
||||
The profile directory shows all accounts that have opted into being shown in the directory, and can be used to quickly find profiles that you may be interested in following.
|
||||
|
||||
The profile directory can be sorted either by recent activity \(the most recently published status\), or by new arrivals \(the most recently created accounts\). The directory can also be filtered to show only local accounts, or to show all known accounts that your website is aware of.
|
||||
The profile directory can be sorted either by recent activity (the most recently published status), or by new arrivals (the most recently created accounts). The directory can also be filtered to show only local accounts, or to show all known accounts that your website is aware of.
|
||||
|
||||
Profiles appear as cards that include a user's display name, address, account bio, and some brief stats such as how many toots they've published, how many followers they have, and the time of their last published status.
|
||||
Profiles appear as cards that include a user's display name, address, account bio, and some brief stats such as how many posts they've published, how many followers they have, and the time of their last published status.
|
||||
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ This is the string that will be matched. The keyword will be searched for in any
|
|||
|
||||
### Expire after {#filter-expire}
|
||||
|
||||
Optionally only apply the filter for a limited amount of time. Expired filters are not automatically deleted, but can be reactivated by setting a new expiry date \(or changing it back to "never" expire\).
|
||||
Optionally only apply the filter for a limited amount of time. Expired filters are not automatically deleted, but can be reactivated by setting a new expiry date (or changing it back to "never" expire).
|
||||
|
||||
### Filter contexts {#filter-context}
|
||||
|
||||
|
|
@ -105,4 +105,4 @@ If you block an entire server:
|
|||
|
||||
{{< figure src="/assets/report-modal.jpg" caption="The report modal allows selecting example statuses, adding a note, and forwarding reports." >}}
|
||||
|
||||
If you see a status or user that is violating the rules of your website, you can report that user to your site's moderators. Clicking the "report" option on the user dropdown or status dropdown will open the report modal. Here, you can \(and should\) add a note about why you are reporting this account. You can attach certain problematic statuses for additional context on why you are reporting the account, and if their conduct is violating the rules of the remote website, you can also choose to forward the report to their site's moderators.
|
||||
If you see a status or user that is violating the rules of your website, you can report that user to your site's moderators. Clicking the "report" option on the user dropdown or status dropdown will open the report modal. Here, you can (and should) add a note about why you are reporting this account. You can attach certain problematic statuses for additional context on why you are reporting the account, and if their conduct is violating the rules of the remote website, you can also choose to forward the report to their site's moderators.
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ menu:
|
|||
|
||||
At any time you want, you can go to Settings > Export and download a CSV file for your current followed accounts, your currently created lists, your currently blocked accounts, your currently muted accounts, and your currently blocked domains. Your following, blocking, muting, and domain-blocking lists can be imported at Settings > Import, where they can either be merged or overwritten.
|
||||
|
||||
Requesting an archive of your toots and media can be done once every 7 days, and can be downloaded in ActivityPub JSON format. Mastodon currently does not support importing toots or media due to technical limitations, but your archive can be viewed by any software that understands how to parse ActivityPub documents.
|
||||
Requesting an archive of your posts and media can be done once every 7 days, and can be downloaded in ActivityPub JSON format. Mastodon currently does not support importing posts or media due to technical limitations, but your archive can be viewed by any software that understands how to parse ActivityPub documents.
|
||||
|
||||
## Redirecting or moving your profile {#migration}
|
||||
|
||||
|
|
@ -29,7 +29,7 @@ Redirecting your account disables posting from that account and displays a "prof
|
|||
|
||||
{{< figure src="/assets/account-move.jpg" caption="Profile move form" >}}
|
||||
|
||||
Moving your account is the same as redirecting your account, but it will also irreversibly force everyone to unfollow your current account and follow your new account, if their software supports the Move activity. Your toots will not be moved, due to technical limitations. There is also a very heavy cooldown period in which you cannot migrate again, so be very careful before using this option!
|
||||
Moving your account is the same as redirecting your account, but it will also irreversibly force everyone to unfollow your current account and follow your new account, if their software supports the Move activity. Your posts will not be moved, due to technical limitations. There is also a very heavy cooldown period in which you cannot migrate again, so be very careful before using this option!
|
||||
|
||||
### Account aliases {#aliases}
|
||||
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ There is a way to filter the federated timeline to view only public posts create
|
|||
|
||||
You can perform quick actions on a post directly from the timeline, or you can click on the post to load an expanded view that shows extra information, such as a full timestamp, interaction counts, and threaded replies, if any. The following actions can be performed on a post:
|
||||
|
||||
* **Reply** to a post by clicking the arrow icon. Your toot will show up in the thread below the post you are replying to.
|
||||
* **Reply** to a post by clicking the arrow icon. Your post will show up in the thread below the post you are replying to.
|
||||
* **Boost** a post by clicking the cycled-arrow icon. The post will be reshared on your profile.
|
||||
* **Favourite** a post by clicking the star icon. The post will be added to your favourites list, and a favourite notification will be delivered to its author.
|
||||
* **Bookmark** a post by clicking the ribbon icon. The post will be privately added to your bookmarks list without generating a notification.
|
||||
|
|
@ -48,7 +48,7 @@ When unread notifications are present, a checkmark will appear in the column hea
|
|||
|
||||
As long as you encounter a person within your app’s user interface, e.g. the web interface on your home server, or your mobile app, you can just click “follow” and you won’t notice a difference if that person is on your server or not.
|
||||
|
||||
However if you come across someone’s public profile hosted on a different server, there’s an obstacle: That server sees you as just another anonymous visitor. Not to worry! You can simply copy the URL of that profile, or of one of their posts, and then paste that URL into the search function.
|
||||
However if you come across someone’s public profile hosted on a different server, there’s an obstacle: That server sees you as just another anonymous visitor. Not to worry! You can copy the URL of that profile, or of one of their posts, and then paste that URL into the search function.
|
||||
|
||||
If you are visiting a public page on another Mastodon site, see [Using Mastodon outside of your site](../external/#interact).
|
||||
|
||||
|
|
@ -62,15 +62,15 @@ If you are following someone, you also have the option to receive a notification
|
|||
|
||||
{{< figure src="/assets/search.jpg" caption="The search function can be accessed from the sidebar." >}}
|
||||
|
||||
Mastodon's basic search allows logged-in users to find toots containing a specific hashtag, or to load a user or status directly if they know the URL or address. Searching for a term will show profiles whose username or display name contains that term, as well as hashtags that match or contain that term.
|
||||
Mastodon's basic search allows logged-in users to find posts containing a specific hashtag, or to load a user or status directly if they know the URL or address. Searching for a term will show profiles whose username or display name contains that term, as well as hashtags that match or contain that term.
|
||||
|
||||
{{< figure src="/assets/direct-url.jpg" caption="An example of a toot being loaded directly by its URL." >}}
|
||||
{{< figure src="/assets/direct-url.jpg" caption="An example of a post being loaded directly by its URL." >}}
|
||||
|
||||
{{< figure src="/assets/search-accounts.jpg" caption="An example of accounts returned when searching for "cats"." >}}
|
||||
|
||||
{{< figure src="/assets/search-hashtags.jpg" caption="An example of hashtags returned when searching for "cats"." >}}
|
||||
|
||||
Admins may optionally install full-text search. Mastodon’s full-text search allows logged-in users to find results from their own toots, their favourites, their bookmarks and their mentions. It deliberately does not allow searching for arbitrary strings in the entire database, in order to reduce the risk of abuse by people searching for controversial terms to find people to dogpile.
|
||||
Admins may optionally install full-text search. Mastodon’s full-text search allows logged-in users to find results from their own posts, their favourites, their bookmarks and their mentions. It deliberately does not allow searching for arbitrary strings in the entire database, in order to reduce the risk of abuse by people searching for controversial terms to find people to dogpile.
|
||||
|
||||
The following operators are supported:
|
||||
|
||||
|
|
@ -82,7 +82,7 @@ The following operators are supported:
|
|||
|
||||
{{< figure src="/assets/dm-column.jpg" caption="A list of conversations containing direct messages." >}}
|
||||
|
||||
In Mastodon, direct messages are simply toots that have the "direct" visibility selected. Visibility can be selected per-post, which allows changing the privacy level later in a thread. The direct messages column currently shows a list of all conversations containing a direct post. Clicking on a conversation will load the associated thread.
|
||||
In Mastodon, direct messages are just posts that have the "direct" visibility selected. Visibility can be selected per-post, which allows changing the privacy level later in a thread. The direct messages column currently shows a list of all conversations containing a direct post. Clicking on a conversation will load the associated thread.
|
||||
|
||||
{{< figure src="/assets/dm-thread.jpg" caption="A direct message in a thread." >}}
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Posting toots
|
||||
title: Posting to your profile
|
||||
description: Sharing your thoughts has never been more convenient.
|
||||
menu:
|
||||
docs:
|
||||
|
|
@ -15,7 +15,7 @@ The main body of each status update can be composed using the text field. The de
|
|||
|
||||
### Links {#links}
|
||||
|
||||
{{< figure src="/assets/compose-links.jpg" caption="Links must start with http\(s\):// and are counted as 23 characters regardless of length." >}}
|
||||
{{< figure src="/assets/compose-links.jpg" caption="Links must start with http(s):// and are counted as 23 characters regardless of length." >}}
|
||||
|
||||
If you include links in your post, they must begin with `http://` or `https://`. All links are counted as 23 characters, no matter how long they actually are, so there is no need to use a link shortener to save characters. In fact, using a link shortener is actively discouraged.
|
||||
|
||||
|
|
@ -47,10 +47,10 @@ You can attach either files or a poll to your status.
|
|||
|
||||
Click the paper clip to attach a file to your post. You can attach the following:
|
||||
|
||||
* **Images** \(PNG, JPG, GIF\) **up to 8MB**. Images will be downscaled to 1.6 megapixels \(enough for a 1280x1280 image\). Up to 4 images can be attached.
|
||||
* **Animated GIFs** are converted to soundless MP4s like on Imgur/Gfycat \(**GIFV**\). You can also upload soundless MP4 and WebM, which will be handled the same way.
|
||||
* **Videos** \(MP4, M4V, MOV, WebM\) **up to 40MB**. Video will be transcoded to H.264 MP4 with a maximum bitrate of 1300kbps and framerate of 60fps.
|
||||
* **Audio** \(MP3, OGG, WAV, FLAC, OPUS, AAC, M4A, 3GP\) **up to 40MB**. Audio will be transcoded to MP3 using V2 VBR \(roughly 192kbps\).
|
||||
* **Images** (PNG, JPG, GIF) **up to 8MB**. Images will be downscaled to 1.6 megapixels (enough for a 1280x1280 image). Up to 4 images can be attached.
|
||||
* **Animated GIFs** are converted to soundless MP4s like on Imgur/Gfycat (**GIFV**). You can also upload soundless MP4 and WebM, which will be handled the same way.
|
||||
* **Videos** (MP4, M4V, MOV, WebM) **up to 40MB**. Video will be transcoded to H.264 MP4 with a maximum bitrate of 1300kbps and framerate of 60fps.
|
||||
* **Audio** (MP3, OGG, WAV, FLAC, OPUS, AAC, M4A, 3GP) **up to 40MB**. Audio will be transcoded to MP3 using V2 VBR (roughly 192kbps).
|
||||
|
||||
#### Editing media {#edit}
|
||||
|
||||
|
|
@ -104,7 +104,7 @@ A more limited delivery option.
|
|||
* Your post cannot be boosted, except by yourself.
|
||||
|
||||
{{< hint style="warning" >}}
|
||||
To effectively publish private \(followers-only\) posts, you must **lock your account**–otherwise, anyone could follow you to view older posts.
|
||||
To effectively publish private (followers-only) posts, you must **lock your account**–otherwise, anyone could follow you to view older posts.
|
||||
{{< /hint >}}
|
||||
|
||||
{{< hint style="danger" >}}
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ In either interface, updates will load automatically as new posts are available.
|
|||
|
||||
For accessibility reasons, the auto-play of animated GIFs is disabled by default. You can enable animated GIFs if you want to see animations. You can also reduce motion of animations throughout the UI.
|
||||
|
||||
Trending hashtags can be shown or hidden below the getting started column in the advanced UI, or below the column switcher in the simple UI \(only when there is enough space to display them\).
|
||||
Trending hashtags can be shown or hidden below the getting started column in the advanced UI, or below the column switcher in the simple UI (only when there is enough space to display them).
|
||||
|
||||
### Confirmation dialogs {#confirm}
|
||||
|
||||
|
|
|
|||
|
|
@ -67,13 +67,20 @@ It’s completely up to you what you put there. The content can contain mentions
|
|||
|
||||
Document-based verification and blue ticks are not possible without a central authority. However, Mastodon can cross-reference the links you put on your profile to prove that you are the real owner of those links. In case one of those links is your personal homepage that is known and trusted, it can serve as the next-best-thing to identity verification.
|
||||
|
||||
If you put a link in your profile metadata, Mastodon checks if the linked page links back to your Mastodon profile. If so, you get a verification checkmark next to that link, since you are confirmed as the owner.
|
||||
|
||||
Behind the scenes, Mastodon checks for the `rel="me"` attribute on the link back. Likewise, Mastodon puts `rel="me"` on the links within profile metadata.
|
||||
|
||||
The profile page you're linking to must be served securely (over HTTPS) in order to pass verification.
|
||||
|
||||
{{< hint style="info" >}}
|
||||
Because Mastodon can be self-hosted, there is no better way to verify your identity than to host Mastodon on your own domain, which people already trust.
|
||||
{{< /hint >}}
|
||||
|
||||
If you put an HTTPS link in your profile metadata, Mastodon checks if that link resolves to a web page that links back to your Mastodon profile with a special `rel=me` attribute. If so, you get a verification checkmark next to that link, since you are confirmed as the owner. Likewise, Mastodon puts `rel="me"` on the links within profile metadata. The link might look something like this:
|
||||
|
||||
```html
|
||||
<a href="https://social.example.com/@username" rel="me">Follow me on Mastodon!</a>
|
||||
```
|
||||
|
||||
More precisely, Mastodon will validate the link under the following conditions:
|
||||
- Since 4.0: the hostname does not change after IDN normalization
|
||||
- it starts with HTTPS
|
||||
- the resolved page contains at least one `a` or `link` tag with a `rel="me"`
|
||||
- the `href` attribute on one of those elements is equal to the URL for your Mastodon profile
|
||||
|
||||
Alternatively, validation will occur if the resolved page's *first* link has an `href` value that redirects to your Mastodon profile's URL (such as through a link shortener).
|
||||
|
|
@ -27,7 +27,7 @@ Here is what you need:
|
|||
- A **VPS**. Something that will run the Mastodon code that will always be connected to the internet.
|
||||
|
||||
**How to get**: DigitalOcean, Hetzner, Exoscale, Scaleway, any of the infinite number of hosting providers. Comes with a monthly or yearly cost that varies depending on hardware specifications.
|
||||
- An **e-mail provider**. Mastodon needs to send confirmation links and various notifications through e-mail, and hosting your own SMTP server, while possible, is much more difficult to do reliably than to simply use a third-party provider.
|
||||
- An **e-mail provider**. Mastodon needs to send confirmation links and various notifications through e-mail, and hosting your own SMTP server, while possible, is much more difficult to do reliably than to use a third-party provider.
|
||||
|
||||
**How to get**: Mailgun, SparkPost, Postmark, Sendgrid, any of the infinite number of e-mail hosting providers that expose a SMTP API. Comes with a monthly cost based on volume of e-mails sent.
|
||||
- Optional: **Object storage provider**. Mastodon can save files that you and your users upload on the hard disk drive of the VPS it runs on, however, the hard disk drive is usually not infinite and difficult to upgrade later. An object storage provider gives you practically infinite metered file storage.
|
||||
|
|
@ -58,4 +58,4 @@ That however does assume a single-machine setup. Mastodon scales quite well hori
|
|||
|
||||
If you're interested in installing everything on your own, proceed here:
|
||||
|
||||
{{< page-ref page="admin/prerequisites.md" >}}
|
||||
{{< page-ref page="admin/prerequisites" >}}
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ Mastodon allows website administrators to set one of three different signup mode
|
|||
|
||||
#### Open signup {#open}
|
||||
|
||||
Some websites may allow you to register immediately -- simply fill out the registration with your username, email address, and password, and you can start using your account.
|
||||
Some websites may allow you to register immediately -- just fill out the registration with your username, email address, and password, and you can start using your account.
|
||||
|
||||
#### Server invites {#invite}
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue