This commit is contained in:
a 2022-12-18 08:12:14 -06:00
parent 7403a1c55f
commit 5d665d4350
256 changed files with 638 additions and 581 deletions

3
.gitmodules vendored Normal file
View File

@ -0,0 +1,3 @@
[submodule "themes/paradox"]
path = themes/paradox
url = https://github.com/trwnh/hugo-theme-paradox.git

View File

@ -1,6 +1,6 @@
---
title: Mastodonマストドンとは
description: Mastodonのドキュメントに、ようこそ
summary: Mastodonのドキュメントに、ようこそ
menu:
docs:
weight: -99

View File

@ -1,6 +1,6 @@
---
title: その他の設定
description: 新しいユーザーの招待、連絡先を並べ替え、安全なアカウント。
summary: 新しいユーザーの招待、連絡先を並べ替え、安全なアカウント。
menu:
docs:
weight: 80

View File

@ -1,6 +1,6 @@
---
title: 自分や他のユーザーの宣伝
description: ハッシュタグ、プロフィール、投稿を目立たせられます。
summary: ハッシュタグ、プロフィール、投稿を目立たせられます。
menu:
docs:
weight: 60

View File

@ -1,6 +1,6 @@
---
title: 外部からのMasotodonの使用
description: 外部のアプリやウェブサイトからMastodonを閲覧して操作できます。
summary: 外部のアプリやウェブサイトからMastodonを閲覧して操作できます。
menu:
docs:
weight: 90

View File

@ -1,6 +1,6 @@
---
title: 見たくないコンテンツへの対処
description: ソーシャルメディアをより快適に体験するため、見るものを制御しよう。
summary: ソーシャルメディアをより快適に体験するため、見るものを制御しよう。
menu:
docs:
weight: 50

View File

@ -1,6 +1,6 @@
---
title: アカウントの引っ越しや削除
description: 自分の情報は自由に扱えます。
summary: 自分の情報は自由に扱えます。
menu:
docs:
weight: 100

View File

@ -1,6 +1,6 @@
---
title: ネットワーク機能の使用
description: どんなサーバーにいる人に対してもフォローしたり、おしゃべりできます。
summary: どんなサーバーにいる人に対してもフォローしたり、おしゃべりできます。
menu:
docs:
weight: 40

View File

@ -1,6 +1,6 @@
---
title: トゥートの投稿
description: かつてないほど便利に、あなたの思いを共有できます。
summary: かつてないほど便利に、あなたの思いを共有できます。
menu:
docs:
weight: 30

View File

@ -1,6 +1,6 @@
---
title: 環境の設定
description: あなたの好きなようにカスタマイズできます。
summary: あなたの好きなようにカスタマイズできます。
menu:
docs:
weight: 70

View File

@ -1,6 +1,6 @@
---
title: プロフィールの設定
description: 新しいアカウントで始めよう。
summary: 新しいアカウントで始めよう。
menu:
docs:
weight: 20

View File

@ -1,6 +1,6 @@
---
title: アカウントの登録
description: あなたにとって最適なコミュニティを見つけよう。
summary: あなたにとって最適なコミュニティを見つけよう。
menu:
docs:
weight: 10

View File

@ -1,6 +1,6 @@
---
title: Czym jest Mastodon?
description: Witamy w dokumentacji Mastodona!
summary: Witamy w dokumentacji Mastodona!
menu:
docs:
weight: -99

View File

@ -1,6 +1,6 @@
---
title: Więcej ustawień
description: Zaproś nowych użytkowników, przeglądaj kontakty i zabezpiecz swoje konto.
summary: Zaproś nowych użytkowników, przeglądaj kontakty i zabezpiecz swoje konto.
menu:
docs:
weight: 80

View File

@ -1,6 +1,6 @@
---
title: Promuj siebie i innych
description: Uwidocznij swoje hashtagi, profile i wpisy.
summary: Uwidocznij swoje hashtagi, profile i wpisy.
menu:
docs:
weight: 60

View File

@ -1,6 +1,6 @@
---
title: Korzystaj z Mastodona zewnętrznie
description: Możesz korzystać i wchodzić w interakcje na Mastodonie z poziomu zewnętrznych aplikacji i stron.
summary: Możesz korzystać i wchodzić w interakcje na Mastodonie z poziomu zewnętrznych aplikacji i stron.
menu:
docs:
weight: 90

View File

@ -1,6 +1,6 @@
---
title: Radzenie sobie z niechcianą treścią
description: Kontroluj co zobaczysz, dla bardziej przyjaznego doświadczenia.
summary: Kontroluj co zobaczysz, dla bardziej przyjaznego doświadczenia.
menu:
docs:
weight: 50

View File

@ -1,6 +1,6 @@
---
title: Przenieś lub opuść konto
description: Zabierz swoje informacje i rób z nimi, co chcesz.
summary: Zabierz swoje informacje i rób z nimi, co chcesz.
menu:
docs:
weight: 100

View File

@ -1,6 +1,6 @@
---
title: Korzystaj z funkcjonalności sieci
description: Obserwuj i rozmawiaj z osobami z dowolnego serwera.
summary: Obserwuj i rozmawiaj z osobami z dowolnego serwera.
menu:
docs:
weight: 40

View File

@ -1,6 +1,6 @@
---
title: Utwórz wpisy
description: Dzielenie się swoimi przemyśleniami nigdy nie było bardziej wygodne.
summary: Dzielenie się swoimi przemyśleniami nigdy nie było bardziej wygodne.
menu:
docs:
weight: 30

View File

@ -1,6 +1,6 @@
---
title: Zmień swoje ustawienia
description: Dostosuj wszystko tak, jak lubisz.
summary: Dostosuj wszystko tak, jak lubisz.
menu:
docs:
weight: 70

View File

@ -1,6 +1,6 @@
---
title: Dostosuj swój profil
description: Rozpocznij korzystanie z nowego konta.
summary: Rozpocznij korzystanie z nowego konta.
menu:
docs:
weight: 20

View File

@ -1,6 +1,6 @@
---
title: Zarejestruj konto
description: Znajdź idealną społeczność dla siebie.
summary: Znajdź idealną społeczność dla siebie.
menu:
docs:
weight: 10

View File

@ -1,6 +1,6 @@
---
title: 什么是Mastodon
description: 欢迎来到Mastodon文档
summary: 欢迎来到Mastodon文档
menu:
docs:
weight: -99

View File

@ -1,6 +1,6 @@
---
title: 备份你的服务器
description: 设置日常备份(可选,但并非如此)
summary: 设置日常备份(可选,但并非如此)
menu:
docs:
weight: 80

View File

@ -1,6 +1,6 @@
---
title: 设置你的环境
description: 为你安装的Mastodon设置环境变量。
summary: 为你安装的Mastodon设置环境变量。
menu:
docs:
weight: 30

View File

@ -1,6 +1,6 @@
---
title: 从源中安装
description: 创建你自己的Mastodon站点的教学指献。
summary: 创建你自己的Mastodon站点的教学指献。
menu:
docs:
weight: 20

View File

@ -1,6 +1,6 @@
---
title: 迁移到新机器
description: 在不损失任何东西的情况下把你的Mastodon复制安装至新的服务器上。
summary: 在不损失任何东西的情况下把你的Mastodon复制安装至新的服务器上。
menu:
docs:
weight: 90

View File

@ -1,6 +1,6 @@
---
title: 运营操作
description: 处理不想要的用户与域名
summary: 处理不想要的用户与域名
menu:
docs:
weight: 110

View File

@ -1,6 +1,6 @@
---
title: 全文搜索
description: 设置Elasticsearch来搜索自己发出的嘟文、自己喜欢的嘟文、自己的书签和自己被提及的嘟文。
summary: 设置Elasticsearch来搜索自己发出的嘟文、自己喜欢的嘟文、自己的书签和自己被提及的嘟文。
menu:
docs:
weight: 10

View File

@ -1,13 +1,13 @@
---
title: 匿名服务
description: 通过Tor的匿名服务来访问Mastodon。
summary: 通过TOR的匿名服务来访问Mastodon。
menu:
docs:
weight: 20
parent: admin-optional
---
可以通过Tor的匿名服务来访问Mastodon。这将给你一个只能通过 Tor 网络连接的 \*.onion 地址。
可以通过TOR的匿名服务来访问Mastodon。这将给你一个只能通过 TOR 网络连接的 *.onion 地址。
## 安装 Tor {#install}
@ -41,13 +41,13 @@ HiddenServiceVersion 3
HiddenServicePort 80 127.0.0.1:80
```
重启 Tor。
重启 tor。
```bash
sudo service tor restart
```
现在,你的Tor域名可以在 `/var/lib/tor/hidden_service/hostname` 找到。
现在,你的tor域名可以在 `/var/lib/tor/hidden_service/hostname` 找到。
## 移动你的Mastodon配置 {#nginx}
@ -77,7 +77,7 @@ error_log /var/log/nginx/mastodon_error.log warn;
```text
server {
listen 80;
server_name mastodon.example.com;
server_name mastodon.myhosting.com;
return 301 https://$server_name$request_uri;
}
@ -89,11 +89,11 @@ map $http_upgrade $connection_upgrade {
server {
listen 443 ssl http2;
list [::]:443 ssl http2;
server_name mastodon.example.com;
server_name mastodon.myhosting.com;
include /etc/nginx/snippets/mastodon.conf;
ssl_certificate /etc/letsencrypt/live/mastodon.example.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/mastodon.example.com/privkey.pem;
ssl_certificate /etc/letsencrypt/live/mastodon.myhosting.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/mastodon.myhosting.com/privkey.pem;
}
```
@ -112,7 +112,7 @@ server {
server {
listen 80;
server_name mastodon.example.com;
server_name mastodon.myhosting.com;
return 301 https://$server_name$request_uri;
}
@ -124,11 +124,11 @@ map $http_upgrade $connection_upgrade {
server {
listen 443 ssl http2;
list [::]:443 ssl http2;
server_name mastodon.example.com;
server_name mastodon.myhosting.com;
include /etc/nginx/snippets/mastodon.conf;
ssl_certificate /etc/letsencrypt/live/mastodon.example.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/mastodon.example.com/privkey.pem;
ssl_certificate /etc/letsencrypt/live/mastodon.myhosting.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/mastodon.myhosting.com/privkey.pem;
}
```

View File

@ -1,6 +1,6 @@
---
title: 配置你的新实例
description: 一些需要在安装完Mastodon做的事情
summary: 一些需要在安装完Mastodon做的事情
menu:
docs:
weight: 50

View File

@ -1,6 +1,6 @@
---
title: 使用管理命令行
description: 可以从命令行运行tootctl命令
summary: 可以从命令行运行tootctl命令
menu:
docs:
weight: 60

View File

@ -1,6 +1,6 @@
---
title: 更多设置
description: 邀请新用户,对你的联系人进行排序,并保护你的帐户。
summary: 邀请新用户,对你的联系人进行排序,并保护你的帐户。
menu:
docs:
weight: 80

View File

@ -1,6 +1,6 @@
---
title: 推广自己和他人
description: 推广话题标签、用户资料和嘟文。
summary: 推广话题标签、用户资料和嘟文。
menu:
docs:
weight: 60

View File

@ -1,6 +1,6 @@
---
title: 站外使用Mastodon
description: 你可以通过外部应用程序或网站来浏览Mastodon或与Mastodon进行交互。
summary: 你可以通过外部应用程序或网站来浏览Mastodon或与Mastodon进行交互。
menu:
docs:
weight: 90

View File

@ -1,6 +1,6 @@
---
title: 处理不想要的内容
description: 控制你看到的内容,以获得更舒适的社交媒体体验。
summary: 控制你看到的内容,以获得更舒适的社交媒体体验。
menu:
docs:
weight: 50

View File

@ -1,6 +1,6 @@
---
title: 迁移或删除帐户
description: 你的信息,由你掌控。
summary: 你的信息,由你掌控。
menu:
docs:
weight: 100

View File

@ -1,6 +1,6 @@
---
title: 使用社交功能
description: 关注并和来自任意服务器的任何人交流
summary: 关注并和来自任意服务器的任何人交流
menu:
docs:
weight: 40

View File

@ -1,6 +1,6 @@
---
title: 发布嘟文
description: 分享你的想法,从未如此便捷。
summary: 分享你的想法,从未如此便捷。
menu:
docs:
weight: 30

View File

@ -1,6 +1,6 @@
---
title: 设置你的首选项
description: 以你喜欢的方式自定义Mastodon。
summary: 以你喜欢的方式自定义Mastodon。
menu:
docs:
weight: 70

View File

@ -1,6 +1,6 @@
---
title: 设置个人资料
description: 开始使用你的新帐户。
summary: 开始使用你的新帐户。
menu:
docs:
weight: 20

View File

@ -1,6 +1,6 @@
---
title: 创建一个帐户
description: 找寻属于你的完美社区。
summary: 找寻属于你的完美社区。
menu:
docs:
weight: 10

View File

@ -1,6 +1,6 @@
---
title: "{{ replace .Name "-" " " | title }}"
description:
summary:
menu:
docs:
parent: entities

View File

@ -1,6 +1,6 @@
---
title: "{{ replace .Name "-" " " | title }}"
description:
summary:
menu:
docs:
parent: methods

View File

@ -0,0 +1,10 @@
<svg width="313" height="81" viewBox="0 0 81 81" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M72.9455 18.4505C71.8169 9.95203 64.5038 3.24329 55.846 1.95268C54.3811 1.73352 48.8453 0.929932 36.0206 0.929932H35.9245C23.0879 0.929932 20.338 1.73352 18.873 1.95268C10.4433 3.21894 2.75813 9.23367 0.884866 17.8418C-0.00373551 22.0789 -0.0998005 26.7787 0.0683132 31.0888C0.308475 37.274 0.356508 43.4348 0.908881 49.5957C1.29314 53.6867 1.95359 57.7412 2.90223 61.7347C4.67943 69.1131 11.8603 75.2497 18.8971 77.7456C26.4261 80.3512 34.5317 80.7894 42.2888 78.9996C43.1414 78.7927 43.982 78.5614 44.8226 78.2935C46.7079 77.6847 48.9173 77.0029 50.5504 75.8097C50.5745 75.7975 50.5865 75.7732 50.5985 75.7488C50.6105 75.7245 50.6225 75.7001 50.6225 75.6635V69.6975C50.6225 69.6975 50.6225 69.6488 50.5985 69.6245C50.5985 69.6002 50.5745 69.5758 50.5504 69.5636C50.5264 69.5515 50.5024 69.5392 50.4785 69.5271C50.4543 69.5271 50.4304 69.5271 50.4064 69.5271C45.4349 70.7325 40.3316 71.3413 35.2281 71.3291C26.4261 71.3291 24.0605 67.0919 23.3881 65.3387C22.8477 63.8168 22.4995 62.2217 22.3554 60.6146C22.3554 60.5902 22.3554 60.5659 22.3674 60.5415C22.3674 60.5172 22.3914 60.4928 22.4155 60.4806C22.4394 60.4685 22.4634 60.4563 22.4874 60.4441H22.5715C27.4588 61.6373 32.4782 62.2461 37.5096 62.2461C38.7225 62.2461 39.9232 62.2461 41.1361 62.2096C46.1915 62.0634 51.5232 61.8077 56.5065 60.8216C56.6265 60.7972 56.7587 60.7729 56.8667 60.7485C64.7201 59.2144 72.1891 54.4172 72.9455 42.266C72.9697 41.7912 73.0417 37.2497 73.0417 36.7627C73.0417 35.0702 73.582 24.7941 72.9576 18.475L72.9455 18.4505Z" fill="url(#paint0_linear_539_135)"/>
<path d="M14.8143 23.1993C14.8143 20.7155 16.7717 18.7188 19.1973 18.7188C21.623 18.7188 23.5802 20.7277 23.5802 23.1993C23.5802 25.6709 21.623 27.6799 19.1973 27.6799C16.7717 27.6799 14.8143 25.6709 14.8143 23.1993Z" fill="white"/>
<defs>
<linearGradient id="paint0_linear_539_135" x1="36.621" y1="0.929932" x2="36.621" y2="80.0712" gradientUnits="userSpaceOnUse">
<stop stop-color="#6364FF"/>
<stop offset="1" stop-color="#563ACC"/>
</linearGradient>
</defs>
</svg>

After

Width:  |  Height:  |  Size: 2.1 KiB

View File

@ -0,0 +1,10 @@
<svg width="75" height="79" viewBox="0 0 75 79" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M73.8393 17.4898C72.6973 9.00165 65.2994 2.31235 56.5296 1.01614C55.05 0.797115 49.4441 0 36.4582 0H36.3612C23.3717 0 20.585 0.797115 19.1054 1.01614C10.5798 2.27644 2.79399 8.28712 0.904997 16.8758C-0.00358524 21.1056 -0.100549 25.7949 0.0682394 30.0965C0.308852 36.2651 0.355538 42.423 0.91577 48.5665C1.30307 52.6474 1.97872 56.6957 2.93763 60.6812C4.73325 68.042 12.0019 74.1676 19.1233 76.6666C26.7478 79.2728 34.9474 79.7055 42.8039 77.9162C43.6682 77.7151 44.5217 77.4817 45.3645 77.216C47.275 76.6092 49.5123 75.9305 51.1571 74.7385C51.1797 74.7217 51.1982 74.7001 51.2112 74.6753C51.2243 74.6504 51.2316 74.6229 51.2325 74.5948V68.6416C51.2321 68.6154 51.2259 68.5896 51.2142 68.5661C51.2025 68.5426 51.1858 68.522 51.1651 68.5058C51.1444 68.4896 51.1204 68.4783 51.0948 68.4726C51.0692 68.4669 51.0426 68.467 51.0171 68.4729C45.9835 69.675 40.8254 70.2777 35.6502 70.2682C26.7439 70.2682 24.3486 66.042 23.6626 64.2826C23.1113 62.762 22.7612 61.1759 22.6212 59.5646C22.6197 59.5375 22.6247 59.5105 22.6357 59.4857C22.6466 59.4609 22.6633 59.4391 22.6843 59.422C22.7053 59.4048 22.73 59.3929 22.7565 59.3871C22.783 59.3813 22.8104 59.3818 22.8367 59.3886C27.7864 60.5826 32.8604 61.1853 37.9522 61.1839C39.1768 61.1839 40.3978 61.1839 41.6224 61.1516C46.7435 61.008 52.1411 60.7459 57.1796 59.7621C57.3053 59.7369 57.431 59.7154 57.5387 59.6831C65.4861 58.157 73.0493 53.3672 73.8178 41.2381C73.8465 40.7606 73.9184 36.2364 73.9184 35.7409C73.9219 34.0569 74.4606 23.7949 73.8393 17.4898Z" fill="url(#paint0_linear_549_34)"/>
<path d="M61.2484 27.0263V48.114H52.8916V27.6475C52.8916 23.3388 51.096 21.1413 47.4437 21.1413C43.4287 21.1413 41.4177 23.7409 41.4177 28.8755V40.0782H33.1111V28.8755C33.1111 23.7409 31.0965 21.1413 27.0815 21.1413C23.4507 21.1413 21.6371 23.3388 21.6371 27.6475V48.114H13.2839V27.0263C13.2839 22.7176 14.384 19.2946 16.5843 16.7572C18.8539 14.2258 21.8311 12.926 25.5264 12.926C29.8036 12.926 33.0357 14.5705 35.1905 17.8559L37.2698 21.346L39.3527 17.8559C41.5074 14.5705 44.7395 12.926 49.0095 12.926C52.7013 12.926 55.6784 14.2258 57.9553 16.7572C60.1531 19.2922 61.2508 22.7152 61.2484 27.0263Z" fill="white"/>
<defs>
<linearGradient id="paint0_linear_549_34" x1="37.0692" y1="0" x2="37.0692" y2="79" gradientUnits="userSpaceOnUse">
<stop stop-color="#6364FF"/>
<stop offset="1" stop-color="#563ACC"/>
</linearGradient>
</defs>
</svg>

After

Width:  |  Height:  |  Size: 2.4 KiB

3
assets/branding/logo.svg Normal file
View File

@ -0,0 +1,3 @@
<svg width="74" height="79" viewBox="0 0 74 79" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path d="M73.7014 17.4323C72.5616 9.05152 65.1774 2.4469 56.424 1.1671C54.9472 0.950843 49.3518 0.163818 36.3901 0.163818H36.2933C23.3281 0.163818 20.5465 0.950843 19.0697 1.1671C10.56 2.41145 2.78877 8.34604 0.903306 16.826C-0.00357854 21.0022 -0.100361 25.6322 0.068112 29.8793C0.308275 35.9699 0.354874 42.0498 0.91406 48.1156C1.30064 52.1448 1.97502 56.1419 2.93215 60.0769C4.72441 67.3445 11.9795 73.3925 19.0876 75.86C26.6979 78.4332 34.8821 78.8603 42.724 77.0937C43.5866 76.8952 44.4398 76.6647 45.2833 76.4024C47.1867 75.8033 49.4199 75.1332 51.0616 73.9562C51.0841 73.9397 51.1026 73.9184 51.1156 73.8938C51.1286 73.8693 51.1359 73.8421 51.1368 73.8144V67.9366C51.1364 67.9107 51.1302 67.8852 51.1186 67.862C51.1069 67.8388 51.0902 67.8184 51.0695 67.8025C51.0489 67.7865 51.0249 67.7753 50.9994 67.7696C50.9738 67.764 50.9473 67.7641 50.9218 67.7699C45.8976 68.9569 40.7491 69.5519 35.5836 69.5425C26.694 69.5425 24.3031 65.3699 23.6184 63.6327C23.0681 62.1314 22.7186 60.5654 22.5789 58.9744C22.5775 58.9477 22.5825 58.921 22.5934 58.8965C22.6043 58.8721 22.621 58.8505 22.6419 58.8336C22.6629 58.8167 22.6876 58.8049 22.714 58.7992C22.7404 58.7934 22.7678 58.794 22.794 58.8007C27.7345 59.9796 32.799 60.5746 37.8813 60.5733C39.1036 60.5733 40.3223 60.5733 41.5447 60.5414C46.6562 60.3996 52.0437 60.1408 57.0728 59.1694C57.1983 59.1446 57.3237 59.1233 57.4313 59.0914C65.3638 57.5847 72.9128 52.8555 73.6799 40.8799C73.7086 40.4084 73.7803 35.9415 73.7803 35.4523C73.7839 33.7896 74.3216 23.6576 73.7014 17.4323ZM61.4925 47.3144H53.1514V27.107C53.1514 22.8528 51.3591 20.6832 47.7136 20.6832C43.7061 20.6832 41.6988 23.2499 41.6988 28.3194V39.3803H33.4078V28.3194C33.4078 23.2499 31.3969 20.6832 27.3894 20.6832C23.7654 20.6832 21.9552 22.8528 21.9516 27.107V47.3144H13.6176V26.4937C13.6176 22.2395 14.7157 18.8598 16.9118 16.3545C19.1772 13.8552 22.1488 12.5719 25.8373 12.5719C30.1064 12.5719 33.3325 14.1955 35.4832 17.4394L37.5587 20.8853L39.6377 17.4394C41.7884 14.1955 45.0145 12.5719 49.2765 12.5719C52.9614 12.5719 55.9329 13.8552 58.2055 16.3545C60.4017 18.8574 61.4997 22.2371 61.4997 26.4937L61.4925 47.3144Z" fill="inherit"/>
</svg>

After

Width:  |  Height:  |  Size: 2.2 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 7.2 KiB

BIN
assets/icon.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

57
assets/styles/colors.scss Normal file
View File

@ -0,0 +1,57 @@
@use "sass:color";
@mixin light {
--link-color: #6364FF;
--link-visited: #6364FF;
--primary-accent: rgb(0, 123, 255);
--primary-accent-transparent: rgba(0, 123, 255,0.25);
--primary-accent-text: #fff;
--ui-background: #fff;
--ui-text: #111;
--ui-text-muted: #666;
--ui-text-bold: #000;
--ui-overlay: #ddd;
--ui-overlay-text: var(--ui-text);
--ui-border: #ddd;
}
@mixin dark {
--link-color: #858AFA;
--link-visited: #858AFA;
--primary-accent: rgb(99 100 255);
--primary-accent-transparent: #573acc7f;
--primary-accent-text: #fff;
--ui-background: rgb(21 1 24);
--ui-text: #ddd;
--ui-text-muted: #999;
--ui-text-bold: #fff;
--ui-overlay: #212121;
--ui-overlay-text: #fff;
--ui-border: rgba(203,213,225,.1);
}
:root {
@include light;
}
@media (prefers-color-scheme: dark) {
:root {
@include dark;
}
}
body.dark-mode {
@include dark;
}
body.light-mode {
@include light;
}

62
assets/styles/custom.scss Normal file
View File

@ -0,0 +1,62 @@
@import "colors";
@import url('https://fonts.googleapis.com/css2?family=Manrope:wght@200;300;400;500;600;700;800&display=swap');
html {
font-family: Manrope,ui-sans-serif,system-ui,-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,Noto Sans,sans-serif,Apple Color Emoji,Segoe UI Emoji,Segoe UI Symbol,Noto Color Emoji
}
/* make the masthead logo line up with the sidebar */
.site-masthead {
svg {
margin-top: 13px;
}
.site-title {
font-weight: 400;
font-size: 24px;
letter-spacing: -1px;
}
padding-bottom: 4px;
*:focus {
padding-bottom: 4px;
}
gap: 0.5em;
width: 18rem;
}
@media (min-width: 60rem) {
.docs-nav {
min-width: 22rem;
}
}
@media (min-width: 1157px) {
.color-switcher {
margin-left: 3em;
margin-right: auto;
}
}
/* re-style nav links */
.header-nav {
.menu {
gap: 2em;
}
a {
text-decoration: none;
color: var(--ui-text-bold);
font-weight: 700;
}
}
.docs-nav {
li::marker {
content: '' !important;
}
a {
text-decoration: none;
color: var(--ui-text);
}
}

View File

@ -2,208 +2,183 @@ baseURL = "https://docs.joinmastodon.org/"
languageCode = "en-us"
defaultContentLanguage = "en"
title = "Mastodon documentation"
pygmentsCodeFences = true
pygmentsStyle = "dracula"
metaDataFormat = "yaml"
paginate = 100
enableGitInfo = true
disablePathToLower = true
theme = "paradox"
[markup]
[markup.tableOfContents]
endLevel = 3
ordered = false
startLevel = 1
[markup.goldmark.renderer]
unsafe = true
disableKinds = ["taxonomy"]
ignoreErrors = ["error-disable-taxonomy"]
[languages.en.menu]
[[languages.en.menu.docs]]
name = "Using Mastodon"
weight = 10
identifier = "user"
url = "/user/"
[[languages.en.menu.docs]]
name = "Running Mastodon"
weight = 20
identifier = "admin"
url = "/admin/"
[[languages.en.menu.docs]]
name = "Developing Mastodon apps"
weight = 30
identifier = "client"
url = "/client/"
[[languages.en.menu.docs]]
name = "Contributing to Mastodon"
weight = 40
identifier = "dev"
url = "/dev/"
[[languages.en.menu.docs]]
name = "Spec compliance"
weight = 50
identifier = "spec"
url = "/spec/"
[[languages.en.menu.docs]]
name = "REST API"
weight = 60
identifier = "api"
url = "/api/"
[[languages.en.menu.docs]]
name = "API Methods"
weight = 70
identifier = "methods"
url = "/methods/"
[[languages.en.menu.docs]]
name = "API Entities"
weight = 80
identifier = "entities"
url = "/entities/"
[frontmatter]
lastmod = ["lastmod", ":git", "date", "publishDate"]
[markup.tableOfContents]
ordered = true
[markup.goldmark.renderer]
unsafe = true
[markup.highlight]
style = "dracula"
codeFences = true
lineNumbersInTable = false
tabWidth = 3
noClasses = false
[outputs]
home = ["HTML", "RSS", "JSON"]
page = ["HTML"]
[languages.pl.menu]
[[languages.pl.menu.docs]]
name = "Korzystaj z Mastodona"
weight = 10
identifier = "user"
url = "/user/"
[[languages.pl.menu.docs]]
name = "Uruchamianie Mastodona"
weight = 20
identifier = "admin"
url = "/admin/"
[[languages.pl.menu.docs]]
name = "Twórz aplikacje dla Mastodona"
weight = 30
identifier = "client"
url = "/client/"
[[languages.pl.menu.docs]]
name = "Współtwórz Mastodona"
weight = 40
identifier = "dev"
url = "/dev/"
[[languages.pl.menu.docs]]
name = "Zgodność ze specyfikacją"
weight = 50
identifier = "spec"
url = "/spec/"
[[languages.pl.menu.docs]]
name = "REST API"
weight = 60
identifier = "api"
url = "/api/"
[[languages.pl.menu.docs]]
name = "Metody API"
weight = 70
identifier = "methods"
url = "/methods/"
[[languages.pl.menu.docs]]
name = "Jednostki API"
weight = 80
identifier = "entities"
url = "/entities/"
[languages.zh-cn.menu]
[[languages.zh-cn.menu.docs]]
name = "使用Mastodon"
weight = 10
identifier = "user"
url = "/user/"
[[languages.zh-cn.menu.docs]]
name = "运营Mastodon"
weight = 20
identifier = "admin"
url = "/admin/"
[[languages.zh-cn.menu.docs]]
name = "开发Mastodon应用"
weight = 30
identifier = "client"
url = "/client/"
[[languages.zh-cn.menu.docs]]
name = "向Mastodon项目做贡献"
weight = 40
identifier = "dev"
url = "/dev/"
[[languages.zh-cn.menu.docs]]
name = "遵循的标准"
weight = 50
identifier = "spec"
url = "/spec/"
[[languages.zh-cn.menu.docs]]
name = "REST API"
weight = 60
identifier = "api"
url = "/api/"
[[languages.zh-cn.menu.docs]]
name = "API 方法"
weight = 70
identifier = "methods"
url = "/methods/"
[[languages.zh-cn.menu.docs]]
name = "API 实体"
weight = 80
identifier = "entities"
url = "/entities/"
[languages.en]
contentDir = "content/en"
languageName = "English"
weight = -99
[languages.ja.menu]
[[languages.ja.menu.docs]]
name = "Mastodonを使う"
weight = 10
identifier = "user"
url = "/user/"
[[languages.ja.menu.docs]]
name = "Mastodonを動かす"
weight = 20
identifier = "admin"
url = "/admin/"
[[languages.ja.menu.docs]]
name = "Mastodonアプリを開発する"
weight = 30
identifier = "client"
url = "/client/"
[[languages.ja.menu.docs]]
name = "Mastodonの開発に貢献する"
weight = 40
identifier = "dev"
url = "/dev/"
[[languages.ja.menu.docs]]
name = "準拠している仕様"
weight = 50
identifier = "spec"
url = "/spec/"
[[languages.ja.menu.docs]]
name = "REST API"
weight = 60
identifier = "api"
url = "/api/"
[[languages.ja.menu.docs]]
name = "API Methods"
weight = 70
identifier = "methods"
url = "/methods/"
[[languages.ja.menu.docs]]
name = "API Entities"
weight = 80
identifier = "entities"
url = "/entities/"
[languages.pl]
contentDir = "content/pl"
languageName = "Polski"
weight = 0
[languages.zh-cn]
contentDir = "content/zh-cn"
languageName = "简体中文"
weight = 1
[languages.ja]
contentDir = "content/ja"
languageName = "日本語"
weight = 2
[languages]
[languages.en]
contentDir = "content/en"
languageName = "English"
weight = -99
[languages.pl]
contentDir = "content/pl"
languageName = "Polski"
weight = 0
[params]
autonumbering = false
borders = true
[languages.zh-cn]
contentDir = "content/zh-cn"
languageName = "简体中文"
weight = 1
[params.editLink]
enabled = true
forge = "github"
repo = "mastodon/documentation"
branch = "master"
[languages.ja]
contentDir = "content/ja"
languageName = "日本語"
weight = 2
[params.masthead]
hideTitle = false
title = "documentation"
svg = "branding/wordmark.svg"
[params.search]
showIn = ["nav"] # nav, header
[[menu.main]]
identifier = 'joinmastodon'
name = 'Join Mastodon'
url = 'https://joinmastodon.org'
weight = 10
[[menu.main]]
identifier = 'blog'
name = 'Read our blog'
url = 'https://blog.joinmastodon.org'
weight = 15
[[menu.main]]
identifier = 'mastodon'
name = 'mastodon/mastodon'
url = 'https://github.com/mastodon/mastodon'
weight = 20
pre = '''
<svg
style="background:white;
border: 1px solid white;
border-radius: 100rem;"
height="1.5rem"
viewBox="0 0 1024 1024"
fill="none"
xmlns="http://www.w3.org/2000/svg">
<path
fill-rule="evenodd"
clip-rule="evenodd"
d="M8 0C3.58 0 0 3.58 0 8C0 11.54 2.29 14.53 5.47 15.59C5.87 15.66 6.02 15.42 6.02 15.21C6.02 15.02 6.01 14.39 6.01 13.72C4 14.09 3.48 13.23 3.32 12.78C3.23 12.55 2.84 11.84 2.5 11.65C2.22 11.5 1.82 11.13 2.49 11.12C3.12 11.11 3.57 11.7 3.72 11.94C4.44 13.15 5.59 12.81 6.05 12.6C6.12 12.08 6.33 11.73 6.56 11.53C4.78 11.33 2.92 10.64 2.92 7.58C2.92 6.71 3.23 5.99 3.74 5.43C3.66 5.23 3.38 4.41 3.82 3.31C3.82 3.31 4.49 3.1 6.02 4.13C6.66 3.95 7.34 3.86 8.02 3.86C8.7 3.86 9.38 3.95 10.02 4.13C11.55 3.09 12.22 3.31 12.22 3.31C12.66 4.41 12.38 5.23 12.3 5.43C12.81 5.99 13.12 6.7 13.12 7.58C13.12 10.65 11.25 11.33 9.47 11.53C9.76 11.78 10.01 12.26 10.01 13.01C10.01 14.08 10 14.94 10 15.21C10 15.42 10.15 15.67 10.55 15.59C13.71 14.53 16 11.53 16 8C16 3.58 12.42 0 8 0Z"
transform="scale(64)"
fill="#1B1F23"/>
</svg>
'''
[[menu.main]]
identifier = 'patreon'
name = 'Become a patron'
url = 'https://patreon.com/mastodon'
weight = 30
pre = '''
<svg xmlns="http://www.w3.org/2000/svg"
height="1.5rem" viewBox="0 0 180 180">
<path
fill="currentColor"
d="M108.8135992 26.06720125c-26.468266 0-48.00213212 21.53066613-48.00213212 47.99733213 0 26.38653268 21.53386613 47.85426547 48.00213213 47.85426547 26.38639937 0 47.8530655-21.4677328 47.8530655-47.85426547 0-26.466666-21.46666613-47.99733213-47.85306547-47.99733213"
/>
<path
fill="currentColor"
d="M23.333335 153.93333178V26.0666679h23.46666576v127.8666639z"
/>
</svg>
'''
# [[menu.main]]
# identifier = 'documentation'
# name = 'mastodon/documentation'
# url = 'https://github.com/mastodon/documentation'
# weight = 30
# pre = '''
# <svg
# style="background:white; border: 1px solid white; border-radius: 100rem;"
# height="1.5rem"
# viewBox="0 0 1024 1024"
# fill="none"
# xmlns="http://www.w3.org/2000/svg">
# <path
# fill-rule="evenodd"
# clip-rule="evenodd"
# d="M8 0C3.58 0 0 3.58 0 8C0 11.54 2.29 14.53 5.47 15.59C5.87 15.66 6.02 15.42 6.02 15.21C6.02 15.02 6.01 14.39 6.01 13.72C4 14.09 3.48 13.23 3.32 12.78C3.23 12.55 2.84 11.84 2.5 11.65C2.22 11.5 1.82 11.13 2.49 11.12C3.12 11.11 3.57 11.7 3.72 11.94C4.44 13.15 5.59 12.81 6.05 12.6C6.12 12.08 6.33 11.73 6.56 11.53C4.78 11.33 2.92 10.64 2.92 7.58C2.92 6.71 3.23 5.99 3.74 5.43C3.66 5.23 3.38 4.41 3.82 3.31C3.82 3.31 4.49 3.1 6.02 4.13C6.66 3.95 7.34 3.86 8.02 3.86C8.7 3.86 9.38 3.95 10.02 4.13C11.55 3.09 12.22 3.31 12.22 3.31C12.66 4.41 12.38 5.23 12.3 5.43C12.81 5.99 13.12 6.7 13.12 7.58C13.12 10.65 11.25 11.33 9.47 11.53C9.76 11.78 10.01 12.26 10.01 13.01C10.01 14.08 10 14.94 10 15.21C10 15.42 10.15 15.67 10.55 15.59C13.71 14.53 16 11.53 16 8C16 3.58 12.42 0 8 0Z"
# transform="scale(64)"
# fill="#1B1F23"/>
# </svg>
# '''
[[menu.social]]
identifier = "mastodon"
pre = '<svg height="1em" viewbox="0 0 75 79" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M73.84 17.49C72.696 9.002 65.3 2.312 56.53 1.016 55.05.797 49.444 0 36.458 0h-.097c-12.99 0-15.776.797-17.256 1.016-8.525 1.26-16.311 7.271-18.2 15.86-.909 4.23-1.006 8.919-.837 13.22.24 6.17.288 12.327.848 18.47a86.879 86.879 0 0 0 2.022 12.115c1.795 7.361 9.064 13.487 16.185 15.986a43.41 43.41 0 0 0 23.68 1.25 34.565 34.565 0 0 0 2.562-.701c1.91-.607 4.147-1.285 5.792-2.477a.187.187 0 0 0 .076-.144v-5.953a.175.175 0 0 0-.216-.17 65.637 65.637 0 0 1-15.367 1.796c-8.906 0-11.301-4.226-11.987-5.985a18.554 18.554 0 0 1-1.042-4.718.171.171 0 0 1 .136-.178.173.173 0 0 1 .08.002 64.383 64.383 0 0 0 15.115 1.795c1.225 0 2.446 0 3.67-.032 5.121-.144 10.52-.406 15.558-1.39.125-.025.251-.047.359-.079 7.947-1.526 15.51-6.316 16.279-18.445.029-.477.1-5.002.1-5.497.004-1.684.543-11.946-.079-18.251Z" fill="url(#a)"/><path d="M61.248 27.026v21.088h-8.356V27.648c0-4.31-1.796-6.507-5.448-6.507-4.015 0-6.026 2.6-6.026 7.735v11.202H33.11V28.875c0-5.134-2.014-7.734-6.03-7.734-3.63 0-5.444 2.198-5.444 6.507v20.466h-8.353V27.026c0-4.308 1.1-7.731 3.3-10.269 2.27-2.531 5.247-3.831 8.942-3.831 4.278 0 7.51 1.644 9.665 4.93l2.079 3.49 2.083-3.49c2.154-3.286 5.386-4.93 9.657-4.93 3.691 0 6.668 1.3 8.945 3.831 2.198 2.535 3.296 5.958 3.293 10.27Z" fill="#fff"/><defs><linearGradient id="a" x1="37.069" y1="0" x2="37.069" y2="79" gradientUnits="userSpaceOnUse"><stop stop-color="#6364FF"/><stop offset="1" stop-color="#563ACC"/></linearGradient></defs></svg>'
url = "https://mastodon.social/@Mastodon"
weight = 10
[[menu.social]]
identifier = "twitter"
pre = '<svg xmlns="http://www.w3.org/2000/svg" xml:space="preserve" viewBox="0 0 248 204" height="1em"><path fill="#1d9bf0" d="M221.95 51.29c.15 2.17.15 4.34.15 6.53 0 66.73-50.8 143.69-143.69 143.69v-.04c-27.44.04-54.31-7.82-77.41-22.64 3.99.48 8 .72 12.02.73 22.74.02 44.83-7.61 62.72-21.66-21.61-.41-40.56-14.5-47.18-35.07a50.338 50.338 0 0 0 22.8-.87C27.8 117.2 10.85 96.5 10.85 72.46v-.64a50.18 50.18 0 0 0 22.92 6.32C11.58 63.31 4.74 33.79 18.14 10.71a143.333 143.333 0 0 0 104.08 52.76 50.532 50.532 0 0 1 14.61-48.25c20.34-19.12 52.33-18.14 71.45 2.19 11.31-2.23 22.15-6.38 32.07-12.26a50.69 50.69 0 0 1-22.2 27.93c10.01-1.18 19.79-3.86 29-7.95a102.594 102.594 0 0 1-25.2 26.16z"/></svg>'
url = "https://twitter.com/@joinmastodon"
weight = 20
[[menu.social]]
identifier = "github"
pre = '<svg style="background:white; border: 1px solid white; border-radius: 100rem;" height="1em" viewBox="0 0 1024 1024" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8C0 11.54 2.29 14.53 5.47 15.59C5.87 15.66 6.02 15.42 6.02 15.21C6.02 15.02 6.01 14.39 6.01 13.72C4 14.09 3.48 13.23 3.32 12.78C3.23 12.55 2.84 11.84 2.5 11.65C2.22 11.5 1.82 11.13 2.49 11.12C3.12 11.11 3.57 11.7 3.72 11.94C4.44 13.15 5.59 12.81 6.05 12.6C6.12 12.08 6.33 11.73 6.56 11.53C4.78 11.33 2.92 10.64 2.92 7.58C2.92 6.71 3.23 5.99 3.74 5.43C3.66 5.23 3.38 4.41 3.82 3.31C3.82 3.31 4.49 3.1 6.02 4.13C6.66 3.95 7.34 3.86 8.02 3.86C8.7 3.86 9.38 3.95 10.02 4.13C11.55 3.09 12.22 3.31 12.22 3.31C12.66 4.41 12.38 5.23 12.3 5.43C12.81 5.99 13.12 6.7 13.12 7.58C13.12 10.65 11.25 11.33 9.47 11.53C9.76 11.78 10.01 12.26 10.01 13.01C10.01 14.08 10 14.94 10 15.21C10 15.42 10.15 15.67 10.55 15.59C13.71 14.53 16 11.53 16 8C16 3.58 12.42 0 8 0Z" transform="scale(64)" fill="#1B1F23"/></svg>'
url = "https://github.com/pixelfed/pixelfed"
weight = 30
[[menu.footer]]
identifier = "source"
name = "View source"
url = "https://github.com/mastodon/documentation"
weight = 10
[[menu.footer]]
identifier = "imprint"
name = "Imprint"
url = "https://joinmastodon.org/imprint"
weight = 10

View File

@ -1,6 +1,6 @@
---
title: What is Mastodon?
description: Welcome to the Mastodon documentation!
summary: Welcome to the Mastodon documentation!
menu:
docs:
weight: -99
@ -24,8 +24,6 @@ A Mastodon website can operate alone. Just like a traditional website, people si
{{< figure src="assets/network-models.jpg" caption="From left to right: Centralized, Federated, Distributed" >}}
## What is ActivityPub? {#fediverse}
Mastodon uses a standardized, open protocol to implement federation. It is called **ActivityPub**. Any software that likewise implements federation via ActivityPub can seamlessly communicate with Mastodon, just like Mastodon websites communicate with one another.

View File

@ -0,0 +1,8 @@
+++
title = "Admin Guide"
summary = "Install and manage your own Mastodon server"
[menu.docs]
name = "Running Mastodon"
weight = 20
identifier = "admin"
+++

View File

@ -1,6 +1,6 @@
---
title: Backing up your server
description: Setting up regular backups (optional, but not really)
summary: Setting up regular backups (optional, but not really)
menu:
docs:
weight: 80

View File

@ -1,6 +1,6 @@
---
title: Configuring your environment
description: Setting environment variables for your Mastodon installation.
summary: Setting environment variables for your Mastodon installation.
menu:
docs:
weight: 30

View File

@ -1,6 +1,6 @@
---
title: Configuring full-text search
description: Setting up Elasticsearch to search for statuses (authored, favourited, or mentioned), public indexable status, and accounts
summary: Setting up Elasticsearch to search for statuses (authored, favourited, or mentioned), public indexable status, and accounts
aliases:
- /admin/optional/elasticsearch
menu:

View File

@ -1,6 +1,6 @@
---
title: Installing from source
description: Instructional guide on creating your own Mastodon-powered website.
summary: Instructional guide on creating your own Mastodon-powered website.
menu:
docs:
weight: 20

View File

@ -1,6 +1,6 @@
---
title: Migrating to a new machine
description: Copying your Mastodon installation to a new server without losing anything.
summary: Copying your Mastodon installation to a new server without losing anything.
menu:
docs:
weight: 90

View File

@ -1,6 +1,6 @@
---
title: Moderation actions
description: Actions that can be taken against unwanted users or domains.
summary: Actions that can be taken against unwanted users or domains.
menu:
docs:
weight: 110

View File

@ -1,14 +0,0 @@
---
title: Installing optional features
menu:
docs:
weight: 40
parent: admin
identifier: admin-optional
---
Mastodon offers a few optional features that can be used if needed.
- [Object storage](./object-storage/)
- [Hidden services](./tor/)
- [Single Sign On](./sso/)

View File

@ -0,0 +1,9 @@
+++
title = "Configuring optional features"
summary = "Instructions on how to enable additional functionality for your Mastodon server"
[menu.docs]
name = "Optional features"
weight = 100
identifier = "admin-optional"
parent = "admin"
+++

View File

@ -1,6 +1,6 @@
---
title: Proxying object storage through nginx
description: Serving user-uploaded files in Mastodon from your own domain
summary: Serving user-uploaded files in Mastodon from your own domain
---
When you are using Mastodon with an object storage provider like Amazon S3, Wasabi, Google Cloud or others, by default the URLs of the files go through the storage providers themselves. This has the following downsides:

View File

@ -1,6 +1,6 @@
---
title: Onion services
description: Serving Mastodon through Tor onion services.
summary: Serving Mastodon through TOR hidden services.
menu:
docs:
weight: 20

View File

@ -1,6 +1,6 @@
---
title: Scaling up your server
descriptions: Optimizations that can be done to serve more users.
summary: Optimizations that can be done to serve more users.
menu:
docs:
weight: 100

View File

@ -1,6 +1,6 @@
---
title: Setting up your new instance
description: Things to do after installing Mastodon
summary: Things to do after installing Mastodon
menu:
docs:
weight: 50

View File

@ -1,6 +1,6 @@
---
title: Using the admin CLI
description: tootctl commands that can be run from the CLI.
summary: tootctl commands that can be run from the CLI.
menu:
docs:
weight: 60

View File

@ -1,31 +1,21 @@
---
title: Troubleshooting errors
menu:
docs:
weight: 120
parent: admin
identifier: admin-troubleshooting
---
+++
title = "Admin Troubleshooting"
summary = "What to do when things go wrong on your Mastodon server"
[menu.docs]
name = "Troubleshooting errors"
weight = 120
identifier = "admin-troubleshooting"
parent = "admin"
+++
## **I see an error page that says something went wrong. How do I find out whats wrong?**
All error messages with stack traces are written to the system log. When using systemd, the logs of each systemd service can be browsed with `journalctl -u mastodon-web` (substitute with the correct service name). When using Docker, its similar: `docker logs mastodon_web_1` (substitute with the correct container name).
Specific details of server-side errors are _never_ displayed to the public, as they can reveal what your setup looks like internally and give attackers clues on how to get in, or how to abuse the system more efficiently.
Specific details of server-side errors are _never_ displayed to the public, as they can reveal what your setup looks like internally and give attackers clues how to get in, or how to abuse the system more efficiently.
Each response from Mastodons web server carries a header with a unique request ID, which is also reflected in the logs. By inspecting the headers of the error page, you can easily find the corresponding stack trace in the log.
## **I'm not seeing much in my logs. How do I enable additional logging/debugging information?**
By default your logs will show `info` level logging. To see more debugging messages, you can your `.env.production` file to increase the level, for the relevant service:
- **Web/Sidekiq:** Set the value of `RAILS_LOG_LEVEL` to `debug` and then restart the service that you're attempting to troubleshoot.
- **Streaming:** Set the value of `LOG_LEVEL` to `silly` and then restart the service that you're attempting to troubleshoot.
More information on other logging levels for these option can be found on the [Configuring your environment](https://docs.joinmastodon.org/admin/config) page.
The `debug` or `silly` levels can be very verbose and you should take care to change the log level back to a lower level, once you have completed your troubleshooting.
## **After an upgrade to a newer version, some pages look weird, like they have unstyled elements. Why?**
Check that you have run `RAILS_ENV=production bin/rails assets:precompile` after the upgrade, and restarted Mastodons web process, because it looks like its serving outdated stylesheets and scripts. Its also possible that the precompilation fails due to a lack of RAM, as webpack is unfortunately extremely memory-hungry. If that is the case, make sure you have some swap space assigned. Alternatively, its possible to precompile the assets on a different machine, then copy over the `public/packs` directory.
@ -40,12 +30,4 @@ Check that you are specifying the correct environment with `RAILS_ENV=production
## **I encountered a compilation error while executing `RAILS_ENV=production bundle exec rails assets:precompile`, but no more information is given. How to fix it?**
Usually, it's because your server ran out of memory while compiling assets. Use a swapfile or increase the swap space to increase the memory capacity. Run `RAILS_ENV=production bundle exec rake tmp:cache:clear` to clear cache, then execute `RAILS_ENV=production bundle exec rails assets:precompile` to compile again. Make sure you clear the cache after a compilation error, or it will show "Everything's OK" but leave the assets unchanged.
## **I am getting this error: `Read-only file system @ dir_s_mkdir`. Why?**
By default, Mastodon makes use of [systemd's sandboxing capabilities](https://www.freedesktop.org/software/systemd/man/systemd.exec.html#Sandboxing) in a way that disallows writing outside of `/home/mastodon`. If Mastodon is installed elsewhere, you may need to allow `mastodon-sidekiq` and `mastodon-web` to write to a custom directory:
1. Add parameter `ReadWritePaths` to files `/etc/systemd/system/mastodon-sidekiq.service` and `/etc/systemd/system/mastodon-web.service`. Example - `ReadWritePaths=/example/mastodon/live`.
2. run `systemctl stop mastodon-sidekiq mastodon-web`
3. run `systemctl daemon-reload`
4. run `systemctl start mastodon-sidekiq mastodon-web`
Usually it's because your server ran out of memory while compiling assets. Use a swapfile or increase the swap space to increase the memory capacity. Run `RAILS_ENV=production bundle exec rake tmp:cache:clear` to clear cache, then execute `RAILS_ENV=production bundle exec rails assets:precompile` to compile again. Make sure you clear the cache after a compilation error, or it will show "Everything's OK" but leave the assets unchanged.

View File

@ -1,6 +1,6 @@
---
title: Database index corruption
description: How to recover from database index corruption.
summary: How to recover from database index corruption.
menu:
docs:
weight: 10

8
content/en/api/_index.md Normal file
View File

@ -0,0 +1,8 @@
+++
title = "REST API"
summary = "Technical information about Mastodon's REST API"
[menu.docs]
name = "REST API"
weight = 60
identifier = "api"
+++

View File

@ -1,6 +1,6 @@
---
title: Guidelines and best practices
description: Things to keep in mind when implementing a Mastodon app.
summary: Things to keep in mind when implementing a Mastodon app.
menu:
docs:
weight: 10

View File

@ -1,6 +1,6 @@
---
title: OAuth Scopes
description: Defining what you have permission to do with the API
summary: Defining what you have permission to do with the API
menu:
docs:
weight: 20

View File

@ -1,6 +1,6 @@
---
title: Rate limits
description: Defining how often you can call the REST API
summary: Defining how often you can call the REST API
menu:
docs:
weight: 30

View File

@ -0,0 +1,8 @@
+++
title = "Client Developer Guide"
summary = "A tutorial on how to use Mastodon's REST API to implement an app"
[menu.docs]
name = "Developing Mastodon apps"
weight = 30
identifier = "client"
+++

View File

@ -1,6 +1,6 @@
---
title: Logging in with an account
description: How to obtain authorization from a user and perform actions on their behalf.
summary: How to obtain authorization from a user and perform actions on their behalf.
menu:
docs:
weight: 40

View File

@ -1,6 +1,6 @@
---
title: Getting started with the API
description: 'A primer on REST APIs, HTTP requests and responses, and parameters.'
summary: 'A primer on REST APIs, HTTP requests and responses, and parameters.'
menu:
docs:
weight: 10

View File

@ -1,6 +1,6 @@
---
title: Libraries and implementations
description: Code, libraries and SDKs for the Mastodon API in a range of programming languages.
summary: Interface with the Mastodon API in the programming language of your choice.
menu:
docs:
weight: 60

View File

@ -1,6 +1,6 @@
---
title: Playing with public data
description: Familiarizing yourself with endpoints and entities.
summary: Familiarizing yourself with endpoints and entities.
menu:
docs:
weight: 20

View File

@ -1,6 +1,6 @@
---
title: Obtaining client app access
description: Getting accustomed to the basics of authentication and authorization.
summary: Getting accustomed to the basics of authentication and authorization.
menu:
docs:
weight: 30

8
content/en/dev/_index.md Normal file
View File

@ -0,0 +1,8 @@
+++
title = "Contributing to Mastodon"
summary = "Useful information for contributing to the Mastodon project"
[menu.docs]
name = "Contributing to Mastodon"
weight = 40
identifier = "dev"
+++

View File

@ -1,6 +1,6 @@
---
title: Code structure
description: Where to find certain parts of the codebase.
summary: Where to find certain parts of the codebase.
menu:
docs:
weight: 30

View File

@ -1,6 +1,6 @@
---
title: Bug bounties and responsible disclosure
description: What to do if you found a serious bug
summary: What to do if you found a serious bug
menu:
docs:
weight: 9999

View File

@ -1,6 +1,6 @@
---
title: Technical overview
description: A description of Mastodon's architecture.
summary: A description of Mastodon's architecture.
menu:
docs:
weight: 10

View File

@ -1,6 +1,6 @@
---
title: Routes
description: How HTTP methods map to controllers and actions.
summary: How HTTP methods map to controllers and actions.
menu:
docs:
weight: 40

View File

@ -1,6 +1,6 @@
---
title: Setting up a dev environment
description: Instructions on how to start developing for Mastodon.
summary: Instructions on how to start developing for Mastodon.
menu:
docs:
weight: 20

View File

@ -1,6 +1,6 @@
---
title: Account
description: Represents a user of Mastodon and their associated profile.
summary: Represents a user of Mastodon and their associated profile.
menu:
docs:
parent: entities

View File

@ -1,6 +1,6 @@
---
title: Admin::Account
description: Admin-level information about a given account.
summary: Admin-level information about a given account.
menu:
docs:
parent: entities

View File

@ -1,6 +1,6 @@
---
title: Admin::CanonicalEmailBlock
description: Represents a canonical email block (hashed).
summary: Represents a canonical email block (hashed).
menu:
docs:
parent: entities

View File

@ -1,6 +1,6 @@
---
title: Admin::Cohort
description: Represents a retention metric.
summary: Represents a retention metric.
menu:
docs:
parent: entities

View File

@ -1,6 +1,6 @@
---
title: Admin::Dimension
description: Represents qualitative data about the server.
summary: Represents qualitative data about the server.
menu:
docs:
parent: entities

Some files were not shown because too many files have changed in this diff Show More