實例設定
這些設定決定你的實例如何營運:註冊模式、貼文長度、預設語系、誰能看到時間軸、實例名稱、說明、服務條款、規則、主題和自訂表情符號。
設定與實例設定
Section titled “設定與實例設定”| 設定 | 實例設定 | |
|---|---|---|
| 內容 | 部署的構成方式:角色、轉接器、端點、主機名稱、密鑰 | 實例的營運方式:註冊模式、貼文長度上限、預設語系、誰能看到時間軸、實例名稱、說明和服務條款 |
| 位置 | 環境變數 MY_* 和設定檔(設定參考) |
資料庫。每次變更都會保留為一個修訂版本 |
| 變更 | 在行程重新啟動時生效 | 透過 my instance set、網頁用戶端的管理畫面或用戶端 API 立即生效(管理畫面與用戶端 API) |
| 未設定時 | 結構描述中的預設值(如果該鍵為必要,伺服器不會啟動) | 程式碼中定義的預設值 |
- 沒有任何鍵同時存在於兩者中。 兩者都不會覆寫對方。你無法透過環境變數或設定檔提供實例設定,也無法將設定值存放在資料庫中。
- 每個部署固定、會改變行程結構的值屬於設定;在實例執行期間會變更的值屬於實例設定。
設定(一個鍵,一個值)
Section titled “設定(一個鍵,一個值)”| 鍵 | 型別 | 預設值 | 說明 |
|---|---|---|---|
registration_mode |
open / approval / invite / closed |
approval |
註冊模式(註冊)。在服務終止已公告期間、關閉之後,以及在單人伺服器上,實際生效的值為 closed。儲存的值不會改變,撤回公告或關閉 single_user 就會恢復。GET /instance 和 NodeInfo 會顯示實際生效的值 |
max_status_length |
整數 1-100000 | 500 |
貼文的最大長度(字元數) |
default_locale |
BCP 47 語言標籤 | en |
預設語系。它是新使用者的初始介面語系,也是沒有任何語言目錄符合使用者偏好時的備用語系 |
local_timeline_visibility |
off / signed_in / everyone |
everyone |
誰能看到本站時間軸(GET /api/v1/timelines/local):沒有人、已登入的使用者,或所有人。off 會回應 404,signed_in 則對未登入的訪客回應 401;兩種情況下導覽列都會隱藏它。除非值為 everyone,否則首頁不會顯示範例貼文。在單人伺服器上,它會被視為 off |
federated_timeline_visibility |
off / signed_in / everyone |
signed_in |
誰能看到聯邦時間軸(GET /api/v1/timelines/federated)。各值的意義與本站時間軸相同,在單人伺服器上也會被視為 off |
preview_image |
媒體 ID(空白 = 未設定) | 空白 | 沒有自己圖片的頁面所使用的連結預覽圖片(og:image),在「設定 → 一般」的「連結預覽」之下。未設定時,會依序使用縮圖、標誌,再使用內建圖片(連結預覽) |
contact_account |
本站帳號的使用者名稱(空白 = 未設定) | 空白 | 用來聯絡營運者的帳號。請參閱聯絡方式與縮圖 |
contact_email |
電子郵件地址(空白 = 未設定) | 空白 | 用來聯絡營運者的電子郵件地址。它也是伺服器寄出郵件的 Reply-To 和署名 |
thumbnail |
媒體 ID(空白 = 未設定) | 空白 | 代表這個實例的圖片(縮圖),用於關於頁面與首頁,並在 preview_image 未設定時用於連結預覽 |
remote_media_policy |
none / avatars / all |
none |
是否保留遠端媒體的副本。none:媒體代理會轉送每個請求。avatars:大頭貼、頁首圖片和自訂表情符號會在 blob 儲存區中快取 remote_media_cache_ttl_seconds 的時間。all:所有遠端媒體都會快取。快取的總大小受設定 remote_media_cache_max_bytes 限制 |
remote_media_cache_ttl_seconds |
整數 60-31536000(秒) | 86400 |
擷取的遠端媒體可以保留多久。它也是媒體代理回應的 Cache-Control: max-age,所以 CDN 和瀏覽器會快取這麼久 |
remote_media_cache_max_bytes |
1 以上的整數(位元組) | 1073741824 |
媒體代理保留的遠端媒體副本的大小上限。每小時的清理會刪除過期的副本,接著刪除超過此上限、最久未被存取的副本 |
authorized_fetch |
true / false |
false |
Authorized Fetch(安全模式)。為 true 時,沒有可驗證 HTTP 簽章的 ActivityPub GET,對物件和集合會回應 401,對使用者的 actor 則回應一份只帶有金鑰的最小文件。實例 actor 一律回傳完整文件,讓任何伺服器都能擷取金鑰來驗證簽章 |
federation_mode |
off / inbound / outbound / both |
both |
聯邦的方向。off:不聯邦。inbound:你可以追蹤並閱讀遠端帳號,但本站的貼文、個人檔案和回應不會送出,來自外部的追蹤會被拒絕(Reject)。outbound:接受來自外部的追蹤並遞送本站貼文,但不接收遠端的貼文和回應。both:雙向收送。變更會立即生效,需要 manage_settings 權限 |
federation_scope |
open / allowlist |
open |
這台伺服器與哪些伺服器聯邦。open:所有沒有被網域處置停權的伺服器。allowlist:只有允許清單上的網域及其子網域;其他每個伺服器都被視為已停權,而且不論 authorized_fetch 怎麼設定,ActivityPub 的 GET 都需要來自被允許伺服器的簽章。切換到 allowlist 會永久結束與被切斷的伺服器之間的追蹤;請參閱只與被允許的伺服器聯邦。變更會立即生效,並需要權限 manage_settings |
dynamic_client_registration |
true / false |
true |
動態用戶端註冊(RFC 7591)。為 true 時,POST /oauth/register 不需驗證即可接受公開用戶端的註冊。為 false 時,該端點會以 403(access_denied)拒絕所有請求;已註冊的用戶端仍可繼續使用。定期任務會依照設定 dynamic_client_unredeemed_retention 和 dynamic_client_idle_retention,刪除未使用的動態註冊用戶端。變更會立即生效,需要 manage_settings |
domain_actions_visibility |
off / signed_in / everyone |
off |
誰能看到已採取處置的網域列表(GET /api/v1/instance/domain_actions):沒有人、已登入的使用者,或所有人(審核) |
domain_actions_rationale_visibility |
off / signed_in / everyone |
off |
誰能看到該列表的公開說明。看不到列表的人永遠看不到它們 |
appeal_window_days |
整數 20-365(天) | 180 |
處置後幾天內,當事人可以提出申訴(審核)。變更它也會改變已採取處置的期限 |
session_origins_retention_days |
整數 90-3650(天) | 180 |
登入後保留該次登入的 IP 位址和 User-Agent 的天數(審核) |
registration_origins_retention_days |
整數 90-3650(天) | 180 |
註冊後保留註冊時 IP 位址的天數 |
reports_retention_days |
整數 180-3650(天) | 365 |
最後一次處理後保留檢舉的天數。被處置引用的檢舉,會與該處置保留一樣久 |
moderation_actions_retention_days |
整數 180-3650(天) | 365 |
處置結束(解除、到期或申訴審查,以較晚者為準)後保留帳號處置和申訴的天數 |
audit_log_retention_days |
整數 365-3650(天) | 730 |
稽核記錄的資料列在記錄後保留的天數 |
remote_status_retention_days |
整數 1-3650(天) | 90 |
當這個實例上沒有任何東西參照遠端貼文時(本站的回覆、轉發、喜歡、書籤、通知,或含有本站貼文的討論串),該貼文在發布後保留的天數 |
remote_status_max_retention_days |
整數 0-3650(天) | 0 |
任何遠端貼文在發布後保留的最長天數,即使這個實例有參照它也一樣。本站的回覆、轉發、喜歡和書籤會留下,並將它顯示為已刪除。0 表示沒有上限 |
relay_status_retention_days |
整數 1-3650(天) | 7 |
只由中繼站帶進來的遠端貼文,在這個實例上沒有任何東西參照它、也沒有本站帳號追蹤其作者時,保留的天數 |
oauth_client_rate_limits |
以逗號分隔的 client_id=requests 配對 |
空白 | OAuth 用戶端的用戶端 API 請求上限,用來抑制讓伺服器過載的用戶端:其所有使用者合計在 5 分鐘內可發出的請求數。變更最多需要一分鐘才會套用 |
search_indexing |
allow / deny |
deny |
搜尋引擎是否可以為實例建立索引。即使為 allow,也只有 indexable 帳號的個人檔案和 public 貼文會被索引(搜尋引擎與 AI 爬蟲) |
ai_usage |
allow / deny_training / deny |
deny |
對 AI 服務的聲明。deny_training 拒絕訓練;deny 拒絕訓練以及 AI 的使用(AI 搜尋、助理、代理程式) |
indexable_default |
true / false |
false |
新帳號的 indexable 預設值。變更它不會改變現有帳號 |
auto_delete_default_enabled |
true / false |
false |
新帳號是否一開始就開啟自動刪除舊貼文。它與其他 auto_delete_default_* 鍵一起構成新帳號所得到的規則(自動刪除舊貼文) |
auto_delete_default_min_age_days |
整數 1-3650(天) | 30 |
新帳號的規則在貼文發布幾天後刪除它 |
auto_delete_default_keep_pinned, auto_delete_default_keep_bookmarked, auto_delete_default_keep_favourited |
true / false |
true |
新帳號的規則是否保留作者釘選、加入書籤或按喜歡的貼文 |
auto_delete_default_keep_media, auto_delete_default_keep_polls |
true / false |
false |
新帳號的規則是否保留含有媒體或投票的貼文 |
auto_delete_default_keep_articles |
true / false |
true |
新帳號的規則是否保留文章 |
auto_delete_default_keep_public, auto_delete_default_keep_local, auto_delete_default_keep_unlisted, auto_delete_default_keep_private |
true / false |
false |
新帳號的規則是否保留該可見範圍的貼文 |
auto_delete_default_keep_direct |
true / false |
true |
新帳號的規則是否保留私訊貼文 |
auto_delete_default_keep_min_boosts, auto_delete_default_keep_min_favourites |
整數 0-1000000 | 0 |
新帳號的規則會保留被轉發或按喜歡至少這麼多次的貼文。0 表示不設門檻 |
auto_delete_max_age_days |
整數 0-3650(天) | 0 |
任何本站貼文在發布後最多保留的天數(上限)。0 表示沒有上限 |
auto_delete_max_allow_pinned |
true / false |
true |
在上限之下,釘選的貼文是否仍可保留 |
auto_delete_max_kept_pins |
整數 1-5 | 5 |
在上限之下,有幾個釘選可以保留貼文,從最近釘選的開始算。5 是帳號可釘選的最大數量,會保留所有釘選的貼文 |
auto_delete_max_allow_bookmarked, auto_delete_max_allow_favourited, auto_delete_max_allow_media, auto_delete_max_allow_polls |
true / false |
false |
在上限之下,作者加入書籤或按喜歡的貼文,或含有媒體或投票的貼文,是否仍可保留 |
auto_delete_max_allow_articles |
true / false |
true |
在上限之下,是否仍可保留文章 |
auto_delete_max_allow_visibilities |
true / false |
false |
在上限之下,是否仍可依可見範圍保留貼文 |
auto_delete_max_allow_thresholds |
true / false |
false |
在上限之下,是否仍可依轉發和喜歡的次數保留貼文 |
auto_delete_grace_days |
整數 0-365(天) | 30 |
新適用上限的帳號,在收到通知後還能保留自己設定的天數。變更它不會移動已通知帳號的日期 |
search_visibilities |
public / local / public,local |
public |
在有搜尋後端的伺服器上,全文搜尋涵蓋哪些貼文。unlisted、private 和 direct 貼文永遠不會被涵蓋,而且只涵蓋設定了 indexable 的帳號。移除某個可見範圍,會將其貼文從索引中移除。新增某個可見範圍,在你重建索引之前,只會找到該可見範圍的新貼文。在 search = none 時沒有作用 |
security_contact |
https: 或 mailto: URI(空白 = 未設定) |
空白 | 回報這台伺服器安全問題的聯絡方式:包括其設定和營運方式,以及其帳號和資料。設定後,伺服器會提供 /.well-known/security.txt(RFC 9116)。這是你的聯絡方式,而不是軟體的:軟體本身弱點的回報,請依照其安全政策的說明轉交給專案 |
require_media_description |
true / false |
false |
附加在本站貼文上的每個媒體檔案(圖片、影片或音訊)是否都需要說明。為 true 時,含有說明缺漏或只有空白字元之檔案的貼文或編輯,會以 422 拒絕。它會以 GET /api/v1/instance 中的 limits.require_media_description 公開,網頁用戶端會將說明欄位設為必填。它與每位使用者的設定 require_media_description 是分開的,後者只在送出前檢查 |
link_cards |
true / false |
true |
是否為貼文中的連結顯示卡片。為 true 時,伺服器會擷取被連結的頁面來建立卡片。為 false 時,它會停止擷取,並隱藏已建立的卡片。若只想在部分網域停止,請參閱連結卡片網域 |
link_cards_ignore_robots_txt |
true / false |
false |
連結卡片的擷取是否略過 robots.txt。為 false 時,伺服器會遵守被連結網站的 robots.txt,所以禁止 my-linkcard 或 * 的網站不會有卡片(連結預覽)。/about/crawler 會告知被連結的網站目前是哪一種。為 true 時,伺服器既不擷取也不使用 robots.txt,被連結的網站也就無法再用它拒絕這些擷取;伺服器仍以 my-linkcard 自稱。只有在缺少的卡片太多時才開啟它。開啟期間建立的卡片,會在關閉後下一次重新擷取時接受檢查。頁面的指示和連結卡片網域在兩種情況下都適用 |
ux_measurement |
true / false |
false |
Web 用戶端是否傳送其回應速度的樣本,以及本伺服器是否保存這些樣本(UX 量測)。樣本不含帳號、位址或 URL。為 false 時,伺服器不收集任何樣本,GET /api/v1/instance 中的 ux_measurement 會告知用戶端不要傳送 |
ux_measurement_share |
整數 1-100(百分比) | 10 |
在 ux_measurement 為 true 時,網頁用戶端會傳送樣本的瀏覽器工作階段所占的比例。每個工作階段在網頁用戶端啟動時抽籤一次;小型伺服器可以用 100 量測每個工作階段 |
oauth_metadata_document_clients |
true / false |
true |
是否接受 Client ID Metadata Document 用戶端。為 true 時,對於 client_id 為 https URL 的授權請求,伺服器會擷取該 URL 的中繼資料,並將其視為用戶端(不需事先註冊)。擷取不會跟隨重新導向,最多讀取 5 KB,並依照其快取指示最多重複使用回應 24 小時。為 false 時,它會停止擷取,並拒絕這些用戶端的授權請求、token 交換和更新 |
finance_visibility |
private / totals / breakdown |
private |
要公開多少營運成本(在 /admin/finance/costs 記錄,在 /admin/finance/publication 設定)。private:不公開任何東西(GET /api/v1/instance/cost_totals 為 404)。totals:只公開每個期間和幣別的總額。breakdown:公開總額,以及依服務商和類別的明細,在資訊頁面(/about 和 /about/costs)和 API 中向所有人顯示。breakdown 會透露你使用哪個服務商(例如哪個雲端)。不論哪個層級,項目名稱、備註和個別付款都保持不公開。公開的期間到包含今天(UTC)的期間為止 |
finance_viewer_item_names |
true / false |
false |
擁有 view_finance 權限的使用者,是否能在財務畫面(/finance、GET /api/v1/finance/cost_totals)上看到成本項目名稱和匯入成本的服務名稱。不論此設定為何,總額以及依服務商和類別的明細一律會顯示 |
finance_viewer_item_memos |
true / false |
false |
擁有 view_finance 的使用者,是否能在財務畫面上看到成本項目的備註。只要名稱或備註的設定其中之一為 true,每個期間就會顯示項目列(服務商、類別和該期間的金額,以及已啟用的名稱和備註)。擁有 manage_finance 的人不論如何都能看到全部 |
finance_viewer_income |
totals / plans |
totals |
擁有 view_finance 的使用者,只能看到收入總額(totals),還是也能看到每個方案的訂閱者人數(plans)。每個方案的金額以及誰付了款永遠不會顯示。如果 income_visibility 為 plans,不論此值為何都會顯示公開的人數。收入可在網頁用戶端的財務畫面(/finance)和 GET /api/v1/finance/income_totals 中查看 |
income_visibility |
private / totals / plans |
private |
要公開多少支持者收入(扣除付款服務商手續費後的金額)。它與 finance_visibility 分開選擇。private:不公開任何東西(GET /api/v1/instance/income_totals 為 404)。totals:只公開每個期間和幣別的收入總額。plans:還會向所有人顯示目前每個方案的訂閱者人數。對於訂閱者很少的方案,人數可能讓人猜出是誰在訂閱。只有在此值和 finance_visibility 都不是 private 時才會顯示收支(收入減去成本);否則收支會透露你隱藏的那一方。不論哪個層級,個別付款、訂閱者、每個方案的金額、總金額和手續費都保持不公開。公開的期間到包含今天(UTC)的期間為止 |
funding_meter_visibility |
off / percent / amounts |
off |
資金進度條所公開的內容:本月的收入(扣除付款服務提供者的手續費後)距離每月目標有多遠,顯示在關於頁面、支持者清單(/about/supporters)以及 GET /api/v1/instance(funding_meter)中。它與目標一起在 /admin/finance/publication 設定,該頁面會停用目前的可見範圍所排除的選項,並說明原因。off:什麼都不公開。percent:只有百分比(捨去到 1%)、該月是否已涵蓋,以及目標中是否包含估計的費用。只有在 finance_visibility 和 income_visibility 都是 private 時才能選擇。amounts:另外還有收入與目標。只有在兩者都不是 private 時才能選擇。當兩者之中只公開了一個時,進度條無法顯示:公開的金額與百分比會洩漏被隱藏的那一邊。變更任一可見範圍,使所選的值不再被允許時,進度條會變成 off,而這項變更會和其他任何變更一樣被記錄與稽核。該月是包含今天(UTC)的日曆月,而且只有目標貨幣的收入才會計入 |
funding_meter_target_amount |
大於零的小數,或空白 | 空白 | 資金進度條的每月目標,以 funding_meter_target_currency 的主要單位表示(1650 日圓、12.50 美元),小數位數不得超過該貨幣所具有的位數。空白:目標是本月的費用,這需要費用都是同一種貨幣;在費用有多種貨幣或為零的月份,不顯示進度條 |
funding_meter_target_currency |
ISO 4217 代碼,或空白 | 空白 | funding_meter_target_amount 的貨幣,例如 JPY。空白:本月費用的貨幣 |
funding_meter_rail |
true / false |
false |
當 funding_meter_visibility 不是 off 時,網頁用戶端除了關於頁面之外,是否也在寬版版面的右欄顯示資金進度條 |
supporter_list_visibility |
off / signed_in / everyone |
off |
誰能看到支持者列表(GET /api/v1/instance/supporters 和 /about/supporters)。off:沒有人(API 回應 404,/about 上沒有連結)。signed_in:只有登入這台伺服器的人(否則 API 回應 401)。everyone:所有人。列表只會顯示選擇公開的有效訂閱者的帳號和方案;金額、按月或按年計費、日期和人數永遠不會顯示。不論 search_indexing 為何,列表頁面和 API 回應一律為 noindex, noarchive |
user_app_registration |
true / false |
true |
已登入的使用者是否能透過用戶端 API(POST /api/v1/oauth_apps)註冊自己的 OAuth 應用程式(公開或機密)。為 false 時,註冊會回應 403。列出、變更和刪除已註冊的應用程式、重新發行密鑰、為自己發行 token,以及其他使用者的授權仍可繼續使用 |
voice_room_starters |
everyone / permitted |
permitted |
在設定 voice 不是 off 時,誰能開設語音聊天室(設定)。everyone:所有已登入、未被停權或限制的本站使用者。permitted:只有 start_voice_rooms 權限的持有者;預設只有內建的 admin 角色擁有此權限,支持者方案的角色也可以擁有 |
voice_public_summary |
true / false |
false |
可見範圍為 local 的語音聊天室頁面,是否向未登入這台伺服器的訪客和遠端使用者顯示其名稱、說明、主持人以及是否仍開放中,並顯示在其連結預覽中。參與者永遠不會顯示。為 false 時,這些訪客只會看到這是給這台伺服器本站使用者的聊天室 |
event_creators |
everyone / permitted |
everyone |
誰能建立活動(活動)。everyone:所有已登入、未被停權或限制的本站使用者。permitted:只有 create_events 權限的持有者;預設只有內建的 admin 角色擁有它,支持者方案的角色也可以擁有它 |
public_counts |
true / false |
true |
首頁(/,未登入時)和 GET /api/v1/instance/overview 是否顯示伺服器有多少成員、使用者在過去 7 天中每天發了多少公開貼文,以及伺服器何時開始運作。只計算這台伺服器使用者的公開貼文;數字每幾分鐘更新一次。為 false 時,API 會省略它們 |
landing_fediverse_explanation |
true / false |
true |
首頁(/,未登入時)是否說明聯邦宇宙的運作方式:這裡的帳號可以追蹤其他伺服器上的人,也可以被他們追蹤 |
landing_features |
true / false |
true |
首頁是否顯示軟體在這台伺服器上能做什麼,並為每個已開啟的功能(語音聊天室、活動、文章、搜尋、翻譯、支持者)附上範例 |
featured_accounts |
最多 20 個本站帳號的使用者名稱,以空白或逗號分隔(空白 = 無) | 空白 | 追蹤對象推薦中優先顯示的帳號,依此順序排在這台伺服器最近發文的人之前。擁有者關閉了「推薦我的帳號,並允許用部分名稱找到它」的帳號不會被推薦。請參閱推薦 |
login_providers_only |
true / false |
false |
在至少啟用一個登入提供者時,註冊和登入是否限定使用登入提供者:密碼和通行金鑰不再能登入,沒有連結提供者的使用者在其工作階段結束後就無法再登入。沒有啟用任何提供者時不適用。my instance set 會印出有多少活躍使用者沒有連結到已啟用的提供者。請參閱登入限定使用登入提供者。 |
invite_creators |
everyone / permitted |
permitted |
除了擁有 manage_invites 的工作人員之外,誰能建立自己的邀請(成員邀請)。everyone:所有已登入、未被停權或限制的本站使用者。permitted:只有 create_invites 權限的持有者;預設只有內建的 admin 角色擁有此權限,支持者方案的角色也可以擁有。在 approval 模式下,可用的邀請會立即核准新使用者,所以 everyone 會讓每位使用者都能略過審查 |
member_invite_max_active |
整數 0-100 | 5 |
一位成員同時可以持有多少個可用的邀請(未撤銷、未過期、未用完);0 表示成員無法建立任何邀請。工作人員的邀請不計入 |
member_invite_max_uses |
整數 1-1000 | 10 |
成員建立的一個邀請可以讓多少人註冊 |
member_invite_max_lifetime_seconds |
整數 3600-31536000(秒) | 2592000(30 天) |
成員建立的一個邀請最長可以有效多久。調低它不會縮短現有的邀請 |
translation_providers |
以逗號分隔的提供者 ID | 空白 | 已啟用的伺服器端翻譯提供者,排在前面的先嘗試。空白時不會將任何東西送給任何提供者。這台伺服器沒有對應提供者的 ID 不會有任何作用。內建的翻譯提供者的 ID 為 libretranslate、deepl、google 和 aws,翻譯外掛的 ID 為 plugin |
translation_provider_visibilities |
以逗號分隔的 provider=visibility|visibility 配對 |
空白 | 每個提供者可以收到什麼。未指定的提供者會收到 public、local 和 unlisted 貼文;provider= 後面沒有內容則什麼都不會收到。private 和 direct 只會送給有明確指定它們的提供者,所以允許一個提供者並不代表允許下一個 |
translation_browser |
布林值 | false |
讀者是否可以使用瀏覽器內建的翻譯功能,這不會將任何東西送到這台伺服器或提供者。同時啟用伺服器端提供者時,提供者優先,而瀏覽器會翻譯伺服器拒絕的內容:沒有提供者接受的貼文或語言、達到每月上限,或提供者失敗時 |
translation_user_monthly_characters |
整數 0-1000000000000 | 50000 |
一位使用者的請求在一個 UTC 月內可以送給翻譯提供者的字元數。為 0 時不會送出任何東西。沒有無上限的值:請設定一個很大的數字 |
translation_server_monthly_characters |
整數 0-1000000000000 | 500000 |
整台伺服器在一個 UTC 月內可以送給翻譯提供者的字元數。為 0 時不會送出任何東西。沒有無上限的值:請設定一個很大的數字 |
translation_retention_days |
整數 1-3650(天) | 30 |
翻譯在產生後保留的天數。閱讀它不會延長期限,而且它會隨貼文一起刪除 |
translation_reports_to_server |
布林值 | false |
版主是否可以將檢舉的文字(被檢舉的貼文和檢舉者的留言)送給伺服器端提供者。不論是誰提出請求,每個提供者仍只會收到 translation_provider_visibilities 允許它的可見範圍:被檢舉的私訊貼文只會送給允許 direct 的提供者,而留言視為 private。留言的翻譯永遠不會保留,已刪除貼文的翻譯也不會,而且字元數只計入 translation_server_monthly_characters。為 false 時,檢舉的任何內容都不會送到提供者 |
event_records_retention_days |
整數 30-3650(天) | 90 |
活動結束或被取消後,要保留多少天誰回覆了它、誰獲准、誰受邀,以及誰對它的候選日期投了票。日期從未確定的活動,會在它最後一個候選日期時結束。活動本身(它的設定、地點、日期與候選日期,以及取消)會保留。被檢舉活動的紀錄會保留到檢舉結束,保存保留的適用方式與其他紀錄相同(紀錄保留) |
voice_participants_retention_days |
整數 30-3650(天) | 90 |
語音聊天室結束後,保留參與者紀錄的天數:參與、發言者和聽眾、舉手、邀請和移除。聊天室本身(名稱、說明、主持人和結束方式)會保留。被檢舉聊天室的紀錄會與檢舉保留一樣久,保留措施也如同其他紀錄一樣適用 |
hook_inbound_status_mode, hook_inbound_follow_mode, hook_signup_check_mode, hook_media_check_mode, hook_local_status_mode, hook_inbound_actor_mode, hook_local_profile_mode |
off, observe, enforce |
observe |
每個決策掛鉤在有外掛時作用到什麼程度。off 只能經由 observe 才能變成 enforce。 |
hook_inbound_status_on_failure, hook_inbound_follow_on_failure, hook_media_check_on_failure, hook_inbound_actor_on_failure |
pass, retry |
pass |
掛鉤在強制執行時,其外掛失敗時要怎麼做(詳細說明)。 |
hook_inbound_status_unfollowed_direct |
布林值 | false |
inbound.status 是否也送出沒有任何本站帳號追蹤之作者的私訊貼文(詳細說明)。使用此掛鉤時,資訊頁面(/about)會載明這一點。 |
hook_signup_check_on_failure |
pass, require_approval |
pass |
signup.check 在強制執行時,其外掛失敗時要怎麼做。 |
hook_signup_check_reject |
布林值 | false |
signup.check 在強制執行時,其 reject 是否會拒絕註冊。關閉時,回應只會被記錄,就像 observe 一樣。 |
hook_local_status_account_age_days |
整數 0-3650(天) | 7 |
local.status 會審查貼文及其編輯的帳號,其帳號年齡須小於此天數;0 表示審查所有帳號。使用此掛鉤時,資訊頁面(/about)會載明這一點。 |
hook_local_profile_account_age_days |
整數 0-3650(天) | 7 |
local.profile 會審查個人檔案變更的帳號,其帳號年齡須小於此天數;0 表示審查所有帳號。使用此掛鉤時,資訊頁面(/about)會載明這一點。 |
hook_decisions_retention_days |
整數 30-3650(天) | 90 |
掛鉤的決策保留的天數。 |
single_user |
布林值 | false |
伺服器是否為單人伺服器。只有在伺服器恰好只有一個本站帳號時才能開啟,隨時都可以關閉 |
max_drafts |
整數 1-10000 | 100 |
一位使用者最多可以在伺服器上保留多少份未排程的草稿。調低它不會刪除任何草稿:超過上限的使用者無法再儲存新的草稿 |
max_scheduled_posts |
整數 1-10000 | 300 |
一位使用者最多可以有多少則排程貼文在等待。調低它不會取消任何排程 |
max_scheduled_posts_per_day |
整數 1-10000 | 25 |
一位使用者最多可以有多少則排程貼文等待在同一個 UTC 日期發布 |
scheduled_post_min_lead_minutes |
整數 1-1440(分鐘) | 5 |
貼文至少要提前多少分鐘排程 |
scheduled_post_max_lead_days |
整數 1-3660(天) | 366 |
貼文最多可以提前多少天排程 |
article_authoring |
everyone / permission |
everyone |
誰能撰寫新的文章:所有本站使用者,或只有角色具有 create_articles 權限的使用者 |
max_article_bytes |
整數 1000-100000(位元組) | 100000 |
文章內文所產生的 HTML 最多有多少位元組 |
max_article_images |
整數 0-100 | 20 |
文章內文中,除了封面之外,作者自己上傳的圖片最多有幾張 |
- 值在儲存前會先正規化(
TRUE變成true,0750變成750,ja_jp變成ja-JP,媒體 ID 轉為小寫)。無效的值會被拒絕,不會寫入任何東西。 preview_image和thumbnail只接受存在的圖片媒體(包括仍在處理中的)。在處理完成之前,以及取代處理失敗的圖片時,preview_image會改用預設圖片。媒體一旦在任何修訂版本中被設定過,未附加上傳檔案的清理就不會刪除它。contact_account只接受未刪除的本站使用者的使用者名稱(以小寫儲存)。contact_email只接受alice@example.com形式的地址。featured_accounts只接受未刪除的本站使用者的使用者名稱;開頭的@會被去掉,名稱會轉為小寫,重複的名稱只保留一個,並以單一空白分隔儲存。
已登入的使用者會看到追蹤對象的推薦(註冊後空白的首頁時間軸上,以及透過 GET /api/v1/accounts/suggestions)。推薦依序為 featured_accounts 中的帳號,接著是過去 30 天內發布過公開或本站貼文的這台伺服器帳號,最後發文的排在最前面。使用者自己的帳號、使用者追蹤、封鎖、靜音或被其封鎖的帳號,以及已停權或停用的帳號,都會被排除。
新帳號會被推薦,也能在帳號搜尋中用名稱的一部分找到。在個人檔案設定中關閉「推薦我的帳號,並允許用部分名稱找到它」的使用者,兩者都會退出:此時搜尋只能用完整的使用者名稱找到該帳號,或者只有追蹤它的人才找得到。
自動刪除舊貼文
Section titled “自動刪除舊貼文”使用者可以讓自己的貼文在發布幾天後自動刪除(「設定」→「刪除舊貼文」)。每位使用者的規則都是自己的:是否開啟、幾天後刪除,以及要保留哪些貼文(釘選、加入書籤和按喜歡的貼文、含有媒體或投票的貼文、文章、所選可見範圍的貼文,以及轉發或喜歡達到一定次數的貼文)。以這種方式刪除貼文,與作者自己刪除相同:貼文曾送達的伺服器會收到 Delete。只有本站帳號的貼文會以這種方式刪除,轉發永遠不會。
auto_delete_default_* 鍵是每個新的本站帳號一開始的規則,不論帳號以何種方式建立(註冊表單、外部登入提供者、邀請或 my admin)。帳號在建立時取得這份規則,之後就歸帳號所有:之後變更這些鍵,既不會改變現有的帳號,也不會改變取得較早值的帳號。設定畫面會將這些值顯示為使用者自己的設定。未設定這些鍵時,新帳號一開始會關閉自動刪除、設為 30 天後,並保留釘選、加入書籤和按喜歡的貼文、文章以及私訊貼文。預設值不會向實例外部的人顯示。設定了上限時,新帳號會取得依下述方式裁切到上限的預設值,讓它一開始就在上限之內。
貼文保留的上限
Section titled “貼文保留的上限”auto_delete_max_age_days 大於 0 時,任何本站貼文在發布後都不會保留超過該天數。對於每個沒有 keep_posts_longer 權限的本站帳號:
- 自動刪除一律開啟:使用者無法關閉它,也無法選擇比上限更多的天數(較少則沒問題)。設定畫面和
PUT /api/v1/preferences/auto_delete都會拒絕這兩者。 - 只有
auto_delete_max_allow_*鍵允許的例外能保留貼文。預設只有釘選的貼文可以,而且是全部;auto_delete_max_kept_pins小於 5 時,只有最近的那幾個釘選能保留其貼文。 - 關閉了自動刪除或從未設定的使用者,也同樣受上限約束。
開啟上限、調低上限或變更例外,都不會改寫任何人的設定。取而代之的是,每小時任務 content.auto_delete_statuses 會找出那些自己的設定所保留的貼文超出上限允許範圍的帳號(因為上限被開啟或調低,或帳號失去了 keep_posts_longer)。它會透過預設開啟的通知和電子郵件,通知每個帳號一次,並告知上限從何時開始適用:通知後的 auto_delete_grace_days。在那之前,帳號自己的設定仍然有效;從那時起,其貼文就依照上限處理。再次回到上限之內的帳號(其使用者變更了設定、取得了 keep_posts_longer,或上限被移除或放寬)就不再受約束,而之後的變更會再次通知它,並給予新的寬限期。
開啟上限後,一小時內就會通知所有受其約束的帳號。刪除會維持一定的速度:每個帳號每小時最多 100 則貼文,每則都會以 Delete 送到該貼文曾送達的伺服器,所以有很多舊貼文的帳號需要數小時或數天才會清空。在這段期間變更設定的使用者,會停止剩下的刪除。
keep_posts_longer 是一項會員權限:將它賦予某個角色,就能讓其持有者自行決定貼文保留多久,並關閉自動刪除。內建的 admin 角色擁有此權限。支持者方案可以帶有它,所以保留貼文更久可以成為方案的福利;訂閱結束時,上限會在寬限期後再次適用。
上限是公開的:GET /api/v1/instance 會在 auto_delete_limit 中回傳它,關於頁面也會顯示它,讓人們在註冊前就知道。變更這些鍵需要 manage_settings,而且和其他設定一樣會記錄在稽核記錄中。在網頁用戶端中,它們位於「伺服器設定」的「貼文刪除」頁面,在儲存開啟或更嚴格的上限之前會先詢問。
草稿與排程貼文
Section titled “草稿與排程貼文”使用者會將貼文的草稿儲存在伺服器上,在另一部裝置上繼續撰寫,並立即或在所選的時間發布。只有作者能讀取自己的草稿;草稿永遠不會進行聯邦、不包含在帳號資料的匯出中,並會在帳號被清除時一併消失。上表中的五項 max_drafts 和 scheduled_post_* 設定限制了它們;超過上限的儲存或排程,會被拒絕,並附上指出該上限的訊息。
- 排程貼文由任務
content.publish_scheduled_draft在它的時間或稍後不久發布,即使該時間比佇列服務的延遲上限還要遠:任務會回來並再次等待。請以my instance set設定它們,例如my instance set max_scheduled_posts 100。 - 貼文是在發布時檢查,而不只是在排程時:到了那時,被審核處置禁止發文的使用者,或是其貼文回覆或引用的貼文已不存在的使用者,不會有貼文發出。草稿會保留,使用者會收到一則說明原因的通知(
scheduled_status_failed,使用者可以在通知設定中關閉它,而且絕不會以電子郵件寄出)。本地貼文的自動審核在使用期間,會在貼文發布時審核該貼文。 - 貼文會蓋上它發布的時間,而舊貼文的自動刪除就從那時開始計算。
- 草稿所附的媒體檔案會在草稿存在期間保留;刪除草稿會讓它們變成未附加,並隨未附加上傳檔案的清理一併移除。文章草稿的封面,以及它的內文所顯示的上傳檔案,也以同樣方式保留。
- 草稿與排程貼文包含文章,它們與貼文一樣被排程與計數。文章草稿在作者撰寫期間可以沒有標題;它在發布時會當作新文章來檢查,而到了那時已不能再撰寫新文章的使用者,不會有文章發出。
文章是有標題、摘要與封面圖片的長篇貼文,它的內文由作者以 Markdown 撰寫。文章在其他各方面都是貼文:它們有可見範圍,可以編輯(並保留歷史)、轉發、按喜歡、引用、回覆、檢舉與刪除,而審核對它們的作用與對貼文相同。伺服器在內文寫成時只轉譯一次:其中的原始 HTML 不會被轉譯,而且只有作者自己上傳的圖片會顯示為圖片;任何其他圖片會變成連結,讓讀者絕不會載入其他網站的圖片。時間軸、通知與搜尋會顯示標題、摘要與封面;內文則顯示在開啟文章的地方。
- 預設所有本站使用者都可以撰寫文章。當
article_authoring設為permission時,只有角色具有create_articles權限的使用者可以撰寫新文章;已經寫好的文章會保留,它們的作者仍然可以編輯。禁止帳號發文的審核處置,也會禁止它撰寫和編輯文章。支持者方案可以將create_articles作為福利。 max_article_bytes限制的是內文的 HTML,而不是 Markdown:接收文章的伺服器計算的是 HTML,而 100,000 位元組(上限)是它們完整保留的大小。一篇約 30,000 字的日文內文放得下。max_article_images限制內文中的圖片。編輯器會在文章發布之前顯示這兩者。- 文章絕不是私訊貼文,也沒有投票、除了它的圖片之外沒有其他附件,也沒有內容警告:敏感的文章會顯示它的標題與摘要,並摺疊內文與封面。
- 舊貼文的自動刪除會保留文章,除非使用者將它關閉(新帳號為
auto_delete_default_keep_articles,在上限之下為auto_delete_max_allow_articles)。 GET /api/v1/instance會在limits.articles中回傳上限,並在article_authoring中回傳撰寫設定。請以my instance set設定它們,例如my instance set article_authoring permission。
本站使用者可以規劃活動,包含日期、時區,以及最多三個地點:這台伺服器的語音聊天室、實體聚會的地點,以及一個連結。主辦人可以改為提供最多 20 個候選日期:看得到活動的使用者對每一個回答可以、可能或不行,然後由主辦人或共同主辦人確認其中一個,這就確定了日期。在那之前,沒有人回答自己是否會來。活動只屬於這台伺服器的使用者:它們永遠不會進行聯邦,遠端使用者和未登入的訪客完全看不到它們。
- 誰可以建立活動由
event_creators決定。主辦人還必須能開設語音聊天室(voice_room_starters和設定voice),才能在其中舉辦活動。 - 活動的語音聊天室會在活動開始時開啟,由主辦人主持,並最多等待 30 分鐘等第一位參與者。它採用活動的標題,以及活動的可見範圍(所有本站使用者、追蹤者、主辦人追蹤的人、互相追蹤的人,或受邀者)。共同主辦人、回答要參加或可能參加的人,以及尚未回答的受邀者,都會受邀加入聊天室,所以當共同主持人接手時,他們仍能看到它。聊天室不會發出開始的貼文,而活動的開始通知是它唯一的通知。
- 無法開啟的聊天室(語音聊天已關閉、主辦人已不能再開設聊天室或正在主持另一個,或是已開啟的聊天室數量達到設定
voice_max_open_rooms所允許的上限),會讓活動維持原樣:主辦人會收到通知,而活動頁面會說明聊天室無法開啟。伺服器在日期設定或變更時,以及開始前一天,都會檢查這一點,並通知主辦人有什麼會讓聊天室打不開。當沒有人來到聊天室時,主辦人也會收到通知。取消活動,或移除它的語音聊天室,會結束聊天室並保留活動。 - 主辦人選擇誰能看到活動:所有本站使用者、主辦人的追蹤者、主辦人追蹤的人、互相追蹤的人,或只有受邀者。受邀者,以及回覆了活動或它的候選日期的人,一律看得到它,而使用者與主辦人或共同主辦人之間的封鎖,會對該使用者隱藏它。
- 活動的地址與連結,只會顯示給主辦人或共同主辦人核准的參加者,除非主辦人將它們顯示給所有看得到活動的人。連結必須是
http或https,而伺服器從不開啟它們。 - 看得到活動的使用者可以將它儲存為 iCalendar(
.ics)檔案,加入自己的行事曆。檔案只會指名該使用者看得到的地點,所以保留給已核准參加者的地址絕不會出現在其中。沒有行事曆訂閱位址。 - 使用者每小時最多建立 10 個活動,一個活動每小時最多送出 100 個邀請。
- 使用者可以檢舉活動,版主可以取消活動;停權或刪除主辦人,會取消該主辦人尚未開始的活動(審核)。誰回覆了以及誰受邀,會在活動之後保留
event_records_retention_days,對其候選日期的投票也一樣。
文字(一個鍵,一個值)
Section titled “文字(一個鍵,一個值)”| 鍵 | 限制 | 說明 |
|---|---|---|
name |
100 個字元,單行(不允許只有空白字元) | 實例名稱(顯示名稱)。請參閱名稱與網域 |
short_description |
500 個字元 | 簡短說明 |
description |
20000 個字元 | 說明 |
terms |
100000 個字元 | 服務條款(Markdown) |
privacy_policy |
100000 個字元 | 隱私權政策(Markdown) |
commerce_disclosure |
100000 個字元 | 付費方案的銷售者揭露事項,例如日本法律要求的標示(Markdown;支持者) |
preview_image_alt |
1500 個字元 | preview_image 圖片的替代文字(og:image:alt)。未設定時,會使用「{instance name} 的圖片」 |
thumbnail_alt |
1500 個字元 | thumbnail 圖片的替代文字 |
- 每段文字只有一個值。管理員以自己喜歡的任何語言寫一次,所有語系的讀者都會看到相同的值;其他語言的讀者則依靠機器翻譯之類的方式。管理欄位的標籤和說明會像其他畫面文字一樣翻譯成檢視者的語言;只有管理員寫的值不會翻譯。
- 伺服器不知道文字的語言,所以網頁用戶端和伺服器產生的畫面在輸出文字時,會使用
dir="auto"和lang=""(HTML 中表示未知語言的值),而不是繼承畫面的語言。 - 將文字設為空白會刪除它。
- 除了 CLI 之外,文字也可以在網頁用戶端的管理畫面中變更(名稱、簡短說明和說明在「伺服器設定」的「一般」頁面
/admin/settings/general;服務條款在/admin/documents/terms,隱私權政策在/admin/documents/privacy-policy,商業揭露事項在/admin/documents/commerce-disclosure,各自是「條款與政策」(/admin/documents)中的一個頁面),或透過用戶端 API(GET /api/v1/admin/instance_texts、PUT /api/v1/admin/instance_texts/{key})變更。兩者都需要角色權限manage_settings,變更會記錄在稽核記錄中(text_changed)。
服務條款與隱私權政策
Section titled “服務條款與隱私權政策”- 請以 Markdown(CommonMark,加上 GitHub Flavored Markdown 的表格、刪除線和自動連結)撰寫
terms、privacy_policy和commerce_disclosure。段落中的換行會保留為換行,#標題則從頁面標題的下一層(h2)開始。 - 伺服器會將它們轉換為 HTML 並加以清理(匿名的
GET /api/v1/instance/documents/{kind}),由網頁用戶端的頁面/about/terms、/about/privacy和/about/commerce顯示。原始 HTML、圖片,以及http、https和mailto以外的連結都會被移除。這些頁面不需要登入(它們是網頁用戶端的頁面,所以需要 JavaScript)。/about/commerce是要提供給付款服務商的 URL。 - 你撰寫的文件會從註冊畫面、伺服器產生的每個畫面的頁尾,以及網頁用戶端(第三欄、選單、設定和登入畫面)連結過去。未撰寫的文件不會被連結,其 API 會回應 404。
- 撰寫了服務條款或隱私權政策時,註冊畫面會在建立按鈕之前列出它們,並附上必填的核取方塊「我已閱讀並同意上述文件」。沒有勾選的註冊會被伺服器拒絕,透過登入提供者的註冊也一樣。兩份文件都沒有時,畫面不會要求同意。
實例分別擁有網域和名稱。
- 網域是設定
host(以及帳號名稱的網域account_domain)。實例執行期間無法變更。即使設定了名稱,帳號名稱(@alice@example.com)、URL、ActivityPub ID 以及GET /api/v1/instance中的domain仍然是網域。 - 名稱是文字
name。凡是向人們稱呼實例的地方都會出現它:網頁用戶端的側邊欄和「關於這個伺服器」、瀏覽器分頁標題、伺服器產生的登入、註冊、電子郵件確認、帳號狀態和授權同意畫面、電子郵件(電子郵件地址確認和給版主的通知)、連結預覽的og:site_name、Web App Manifest 的name/short_name、NodeInfo 的metadata.nodeName,以及GET /api/v1/instance中的name。 - 名稱在所有語系中都相同。沒有名稱時,會改為顯示網域(
host)。 - 變更會從下一個請求開始生效,不需要重新啟動。在管理畫面儲存後,已開啟的網頁用戶端的分頁標題和側邊欄也會更新。
聯絡方式與縮圖
Section titled “聯絡方式與縮圖”營運者的聯絡方式(contact_account、contact_email)和代表實例的圖片(thumbnail 和文字 thumbnail_alt)會出現在以下地方。未設定的項目不會出現。
- 網頁用戶端的「關於這個伺服器」(
/about)。縮圖和聯絡帳號也會在未登入者看到的第一個畫面(/)上出現。 GET /api/v1/instance中的contact(account和email)和thumbnail(url、width、height、alt)。- NodeInfo 中的
metadata:依照 Misskey 慣例的maintainer(name為聯絡帳號的顯示名稱,沒有時則為其使用者名稱;email為contact_email)、依照 Pleroma 和 Akkoma 慣例的staffAccounts(聯絡帳號的 actor ID)、thumbnail(url和alt),以及取自簡短說明short_description的nodeDescription。
聯絡帳號被停權或刪除時,不會顯示該帳號,只會顯示電子郵件地址。請在網頁用戶端管理畫面的「一般」頁面(「伺服器設定」,/admin/settings/general)中,或透過 CLI 或用戶端 API 變更。
只屬於營運者一人的伺服器,也就是營運者自己在聯邦宇宙中的家,就是單人伺服器:請開啟 single_user。在網頁用戶端中,管理員可以在「伺服器設定」的「註冊」頁面,用「單人伺服器」來開啟或關閉它;伺服器有一個以上的本站帳號而拒絕時,該頁面會說明原因。
my instance set single_user truemy instance set single_user false # back to a community server- 只有在恰好只有一個本站帳號被計算時才能開啟。每個未刪除的本站帳號都會被計算,包括待核准、已停用、預定刪除、已停權或已限制的帳號,因為每一個都可能以第二個人的身分回來。註冊被拒絕的帳號不計算。在其他任何數量下,
my instance set會附上數量而失敗,管理 API 則會以類型/api/v1/problems/single-user-requires-one-account回應422。伺服器的實例 actor 不是帳號,永遠不計算。 - 隨時都可以關閉。開啟或關閉都不會刪除任何東西,也不會改變任何其他設定的儲存值:它所限制的事項在關閉後會恢復原狀。和所有設定一樣,變更會寫入稽核記錄。
開啟期間:
- 註冊關閉。 不論
registration_mode儲存的值為何,都會被視為closed,所以註冊頁面、透過登入提供者的註冊以及my admin create都不會建立帳號。使用登入提供者登入仍可運作。 - 只有首頁時間軸。
local_timeline_visibility和federated_timeline_visibility會被視為off。主題標籤和列表時間軸則保留。 - 社群才需要的功能會被隱藏。 本站和聯邦時間軸及其串流、帳號推薦、使用者和管理員的邀請、註冊審查,以及註冊封鎖,都會以類型
/api/v1/problems/single-user-mode回應404。 - 不能發新的鄰里貼文。 在只有一個人的伺服器上,「鄰里」的貼文除了追蹤者之外送不到任何人,所以新貼文不能設為鄰里:用戶端 API 會回應
422,並將它從帳號可用的發文選項中排除。預設可見範圍為「鄰里」時會被視為「僅追蹤者」且無法儲存,而給這台伺服器使用者的語音聊天室,會以給追蹤者的貼文來宣告。已經是鄰里的貼文仍保持鄰里。 - 伺服器會表明自己的性質。
GET /api/v1/instance中的single_user為true,並附上實際生效的註冊模式和時間軸,以及作為single_user_account的營運者帳號;NodeInfo 則回應openRegistrations: false和metadata.singleUser: true。 - 首頁就是營運者的個人檔案。 未登入的人開啟伺服器的網址時,會看到其唯一帳號的個人檔案,以及登入方式,和伺服器公開的關於頁面、服務條款和隱私權政策的連結。網頁用戶端會從導覽列、選單和管理畫面中隱藏伺服器不提供的功能:本站和聯邦時間軸、註冊、推薦帳號、邀請、註冊審查、註冊封鎖、可見範圍「鄰里」,以及註冊、邀請、公開時間軸、首頁和推薦帳號的設定。
聯邦、審核、全文搜尋、支持者計畫、文件和管理畫面,都和其他伺服器一樣運作。
my instance list # all settings (and whether each is the default) and textsmy instance get registration_modemy instance set registration_mode openmy instance set name "Example Social" # the same name in every localemy instance set description - < description.txt # the value "-" reads standard inputmy instance get namemy instance set name "" # delete the namemy instance history registration_mode # revision history (newest first, -limit sets the count)my instance history descriptionmy instance set -owner admin preview_image ./preview.png # upload the image as media of admin and use it as the preview imagemy instance set preview_image 0192f3a4-7b1c-7d2e-9f00-1a2b3c4d5e6f # give the ID of media that is already uploadedmy instance set preview_image_alt "A blue bird mascot"my instance set preview_image "" # back to the bundled default imagemy instance set contact_account admin # the contact accountmy instance set contact_email admin@example.commy instance set -owner admin thumbnail ./thumbnail.png # the thumbnailmy instance set thumbnail_alt "A town by the sea"- 旗標請寫在鍵和值之前。
- 使用
-owner <username>時,preview_image或thumbnail的值會被當作圖片檔案的路徑讀取,並作為該本站帳號的媒體上傳。圖片在使用前會由 worker 處理。建議使用 1200x630 的橫向圖片。 - 變更會在一個交易中記錄修訂版本(
instance_*_revisions)並更新目前的值(instance_settings/instance_texts)。從 CLI 進行的變更不記錄執行者(歷史記錄中的BY為cli)。 - 再次設定相同的值,仍會新增一個修訂版本。
- 結束代碼:0 表示成功,1 表示值被拒絕或資料庫錯誤(不會有任何變更),2 表示引數錯誤。
變更聯邦的方向
Section titled “變更聯邦的方向”- 縮小方向時,會保留追蹤關係、匯入的貼文和遞送紀錄,也不會送出
Undo或Reject。流動只是停止,回到both(或其他模式)就會恢復原狀。 - 縮小期間發布的貼文和回應,在你再次擴大後不會追溯遞送。
- 在遠端那一側,模式為
inbound時本站使用者的追蹤者什麼都收不到;模式為outbound或off時,本站使用者的追蹤不會更新。 - 模式為
off時進行的刪除(貼文或帳號)不會送出。在inbound和outbound下,撤回已經送出的內容(Delete等)會送給原本的收件者和當時的追蹤者。 - 變更會記錄在
instance_setting_revisions和稽核記錄(target_kind = setting)中。
若要連關係也一併切斷,請使用 CLI my admin federation sever。
my admin federation sever -direction in # end follows of local users by remote accountsmy admin federation sever -direction out # end follows of remote accounts by local usersmy admin federation sever -direction both- 它會將本站與遠端帳號之間待處理和有效的追蹤,以審核所做的終止來結束(
follow_terminations,reason = moderation)。變更模式永遠不會自動呼叫它。 - 只有在目前的模式會送出該方向時,才會將
Reject(in)或Undo(out)送到遠端那一側。在不送出的模式(例如off)下,追蹤只會在本站這一側結束,遠端那一側不會被告知。 - 重複執行是安全的。它會將結束的追蹤數印到標準輸出。
管理畫面與用戶端 API
Section titled “管理畫面與用戶端 API”CLI 能變更的每項設定,也都能在網頁用戶端的管理畫面和透過用戶端 API 變更。兩者都需要角色權限 manage_settings(只有內建的 admin 角色擁有)。和 CLI 一樣,變更會保留為修訂版本,並按鍵記錄在稽核記錄中(setting_changed,目標為該設定,執行者為該使用者)。請在審核畫面(「稽核日誌」,/moderation/audit-log)查看稽核記錄。
-
網頁用戶端(「伺服器設定」,
/admin/settings):畫面依主題分為多個頁面,並分成幾個群組。每個頁面有一個表單和一個儲存按鈕,儲存時只會送出你在該頁面上變更的內容;其他頁面上的設定維持原狀。各選項會帶來重大差異的選擇,會在儲存之前於其下方說明每個選項的作用;數字被拒絕時,會說明它的範圍。頁面 區塊與設定 一般( /admin/settings/general)名稱與說明( name、short_description、description);語言(default_locale,從應用程式支援的語言中選擇);聯絡方式(contact_account、contact_email);圖片(thumbnail和文字thumbnail_alt、preview_image和文字preview_image_alt)圖示與標誌( /admin/settings/branding)圖示、標誌和深色背景用的標誌(標誌與圖示) 註冊( /admin/settings/registration)誰能註冊( registration_mode,每種模式都附上它的作用);單人伺服器(single_user);成員邀請(invite_creators、member_invite_max_active、member_invite_max_uses、以小時計的member_invite_max_lifetime_seconds);僅限登入提供者(login_providers_only,儲存前會先詢問,並附上有多少活躍使用者將無法再登入,以及你是否為其中之一);應用程式(user_app_registration、dynamic_client_registration、oauth_metadata_document_clients、oauth_client_rate_limits)。在單人伺服器上,註冊和成員邀請的區塊會說明沒有其他人會註冊貼文與功能( /admin/settings/content)貼文( max_status_length、require_media_description);時間軸(local_timeline_visibility、federated_timeline_visibility);連結卡片(link_cards、link_cards_ignore_robots_txt);草稿與排程貼文(max_drafts、max_scheduled_posts、max_scheduled_posts_per_day、scheduled_post_min_lead_minutes、scheduled_post_max_lead_days);文章(article_authoring、max_article_bytes、max_article_images);活動(event_creators、event_records_retention_days);首頁與推薦(public_counts、landing_fediverse_explanation、landing_features、featured_accounts)語音聊天( /admin/settings/voice)誰能開設聊天室( voice_room_starters);聊天室(voice_public_summary、voice_participants_retention_days)貼文刪除( /admin/settings/auto-delete)新帳號的預設值( auto_delete_default_*設定);所有人的上限(auto_delete_max_age_days、auto_delete_grace_days、auto_delete_max_allow_*設定、auto_delete_max_kept_pins)。儲存開啟或更短的上限時會先詢問(貼文保留的上限)聯邦( /admin/settings/federation)方向( federation_mode);伺服器(federation_scope:儲存allowlist時,會先顯示這次切換將結束的追蹤並詢問,請參閱只與被允許的伺服器聯邦);簽章擷取(authorized_fetch);來自其他伺服器的媒體(remote_media_policy、以分鐘計的remote_media_cache_ttl_seconds、以 MiB 計的remote_media_cache_max_bytes);來自其他伺服器的貼文(remote_status_retention_days、remote_status_max_retention_days、relay_status_retention_days);受處置的伺服器(domain_actions_visibility、domain_actions_rationale_visibility)搜尋與爬蟲( /admin/settings/discovery)搜尋引擎( search_indexing、indexable_default);安全聯絡方式(security_contact);AI(ai_usage);全文搜尋(search_visibilities)外部審核( /admin/settings/hooks)每個決策掛鉤各有一個區塊:它的模式(只有在不是 off之後才會提供enforce)、外掛失敗時要怎麼做,以及它的其他設定;決策紀錄(hook_decisions_retention_days)。請參閱決策掛鉤申訴與紀錄( /admin/settings/records)申訴( appeal_window_days);保存紀錄(session_origins_retention_days、registration_origins_retention_days、reports_retention_days、moderation_actions_retention_days、audit_log_retention_days)在「一般」頁面上,圖片會在你儲存時上傳,並在那時成為縮圖或連結預覽圖片。誰能看到營運成本、收入和支持者列表,是在「費用與收入」和「支持者」畫面上設定的。翻譯的設定有自己的畫面,見下文。
-
網頁用戶端(「翻譯」,
/admin/translation):這台伺服器擁有的提供者、它們的順序以及各自可以收到什麼、瀏覽器的翻譯、每月上限,以及翻譯保留多久,並顯示本月送出的字元數和快取命中率。每個伺服器行程最多每分鐘將其快取命中次數加到命中率一次,所以最新的請求可能需要一分鐘才會顯示,而停止的行程可能會留下最後一分鐘未計入。在啟用伺服器端提供者之前,請先更新你的隱私權政策(範本):送給提供者的文字無法收回。提供者的 API 金鑰和翻譯外掛的位址存放在部署設定中;任何設定和用戶端 API 的回應都不會包含它們。 -
翻譯上限。 計算的是送出的字元數(以碼位計):代替提及、連結等的標記不計入,伺服器已保留的翻譯、已經是讀者語言的貼文,以及瀏覽器的翻譯也都不計入。每次呼叫提供者都會計入,失敗的呼叫也一樣,因為提供者可能已經收到文字,所以這個數字可能與提供者的計費不同。超過上限時,請求會以
429拒絕,且不會呼叫任何提供者;此時若你允許且瀏覽器能翻譯該貼文,網頁用戶端會改用讀者瀏覽器的翻譯。月份以 UTC 計算。 -
用戶端 API:
GET /api/v1/admin/settings會回傳每項設定的目前值、預設值、是否已設定,以及其型別和可接受的值(選項或範圍)。PATCH /api/v1/admin/settings會以{"values": {"<key>": "<value>", ...}}一次變更多項設定。所有值都是字串,會和 CLI 一樣正規化後儲存。只要有一個鍵未知或一個值無效,就會回應指出該鍵的 422,而且不會有任何變更。變更的鍵會在同一個交易中記錄為修訂版本並寫入稽核記錄。 -
在
open、approval和invite模式下可用的邀請,是在審核畫面(「邀請」,/moderation/invites,權限manage_invites;請參閱邀請碼)中建立,成員也可以在invite_creators允許的範圍內建立(成員邀請)。
實例的規則會出現在 GET /api/v1/instance 的 rules 中,檢舉會以 ID 引用它們。
- 一條規則有一句單行的文字(最多 300 個字元)和選填的補充說明(最多 1,000 個字元)。和文字一樣,管理員以自己喜歡的任何語言撰寫,所有語系都會看到相同的值(
dir="auto"和lang="")。有效的規則最多 100 條。 - 每次變更(修改文字、重新排序)都會保留為修訂版本(
instance_rule_revisions),規則的 ID 不會改變。 - 廢止的規則會從有效規則列表中消失。它無法恢復,但檢舉仍可以引用它。
my instance rule create -hint "No harassment" "Be kind" # add at the end of the active rulesmy instance rule edit <rule> "Always be kind" # change the sentence; the supplement changes only with -hintmy instance rule move <rule> 1 # move to position 1 and renumber the active rules 1, 2, ...my instance rule retire <rule> # retire itmy instance rule list # active rules (-all includes retired ones)- 管理 API 為
/api/v1/admin/rules(列出、新增、取得、修改、移動、廢止),需要角色權限manage_rules。 - 在網頁用戶端的管理畫面(「規則」,
/admin/rules,manage_rules)中,列表會依序顯示有效的規則,可以用「上移」和「下移」重新排序;列表上方的篩選器可以改為顯示已廢止的規則。「新增規則」會開啟一個填寫文字和補充說明的頁面。選擇規則的文字可以開啟其頁面,在那裡編輯它,或(經過確認對話框後)廢止它。每次變更都會記錄在稽核記錄中(rule_added、rule_revised、rule_moved、rule_retired)。 - 結束代碼與設定相同(0 表示成功,1 表示值被拒絕或資料庫錯誤,2 表示引數錯誤)。
連結卡片網域
Section titled “連結卡片網域”貼文的連結卡片(link_cards)來自一個爬蟲:伺服器會擷取被連結的頁面及其圖片。規則會讓這個爬蟲在某個網域及其子網域上停止,而不影響該網域的其他一切。規則有兩種模式之一。規則是營運者的選擇,除了被連結網站本身拒絕的內容之外另外適用(連結預覽)。
| 模式 | 擷取的內容 | 已有的卡片 |
|---|---|---|
停止擷取(no_fetch) |
不擷取該網域的任何東西,頁面和圖片都不擷取,經由重新導向到達時也一樣 | 隱藏 |
只停止圖片(no_images) |
擷取頁面,但不擷取該網域的圖片 | 顯示,但不含圖片 |
- 規則只與連結卡片有關。該網域仍會聯邦,其貼文的媒體也照常擷取:若要切斷某台伺服器,請使用網域處置,它也會停止其連結卡片。規則不會與網域處置一起列出或匯出。
- 規則涵蓋網域及其子網域,圖片則會以頁面和圖片兩者的主機來檢查。涵蓋某個主機的所有規則都會適用,所以子網域上的規則不會放寬其上層網域的規則。網域的寫法和正規化方式與網域處置相同:不含 scheme 或連接埠的主機名稱,國際化網域可用任何拼寫方式。
- 變更會立即生效,已有的卡片也一樣,而且在停止圖片期間,這些卡片經代理的圖片也會停止提供。
- 移除規則後,伺服器已有的卡片會恢復原狀。被略過的連結,會在下次有貼文需要時取得卡片;不會大量重新擷取。在停止圖片期間重新擷取的卡片,在下一次重新擷取之前都不會有圖片。
- 在網頁用戶端的管理畫面(「連結卡片網域」,
/admin/link-card-domains,manage_settings)中,「新增規則」可以設定附帶模式和備註的規則,並拒絕已經有規則的網域,同時附上該規則的連結。列表依網域顯示規則,每次 40 條,可用「顯示更多」載入更多;選擇網域會開啟其規則的頁面,在那裡可以變更模式和備註,或(經過確認對話框後)移除它。 - 管理 API 為
/api/v1/admin/link_card_domains(列出、設定;以網域發出DELETE即可移除),需要角色權限manage_settings。一台伺服器最多保存 1,000 條規則,每條的備註最多 5,000 個字元。 - 每次變更都會記錄在稽核記錄中(
link_card_domain_fetch_stopped、link_card_domain_images_stopped、link_card_domain_rule_removed)。
伺服器範圍的主題是一組對網頁用戶端設計代碼的覆寫,每種顏色都有淺色與深色兩個值。它適用於每位瀏覽者的網頁用戶端,也適用於伺服器自己算繪的畫面(登入、註冊、條款等)。沒有自訂 CSS。
-
你可以覆寫下列設計代碼;間距、元件的尺寸、文字的字重、陰影與資料圖表的顏色維持固定:
代碼 種類 覆寫 color-surface,color-surface-raised,color-surface-raised-hover,color-surface-raised-pressed,color-surface-hover,color-surface-pressed,color-text,color-muted-text,color-accent,color-on-accent,color-accent-text,color-quote-bar顏色 淺色與深色各一個 #rrggbbfont-sans-override,font-mono-override字型家族 字型家族名稱,以逗號分隔(最多 30 個),不可包含 sans-serif這類通用字型家族;名稱中含有以數字開頭的單字時要加引號,例如"M PLUS 1p"text-tagline,text-headline,text-heading,text-title,text-reading,text-body,text-caption長度 0或 rem / px,0.625rem 到 3rem上述同樣七個代碼各自的 text-*--line-height數字 1 到 2.5 radius-control,radius-overlay長度 0 到 2rem duration-spin時間長度 ms / s,0 到 1000ms -
網頁用戶端以自帶的字型繪製文字:表情符號用 Noto Color Emoji,拉丁字母、希臘字母和西里爾字母用 Noto Sans,其餘文字用與文字語言相應字形的 Noto Sans CJK。
font-sans-override(內文)與font-mono-override(程式碼)中的字型緊排在表情符號字型之後,你的字型所缺少的字元由網頁用戶端的字型繪製。主題無法取代這些字型。 -
你把一組設定儲存為草稿,預覽之後再發布;發布之前,生效中的主題不會改變。每次儲存都會取代整份草稿,每次發布都是一個新的修訂。還原會再次發布目前這組之前生效的那一組,草稿維持不變。
-
在網頁用戶端中,管理 > 主題會顯示草稿和生效中的主題。「編輯草稿」會顯示每種顏色的淺色與深色,以及它所形成的每一對顏色的對比度,低於最低值的組合不會儲存。「預覽」會在你的瀏覽器分頁的每個畫面上顯示草稿,直到你再按一次為止;其他人看不到。「發布」和「還原上一個主題」在同一個畫面上。圖示和標誌在伺服器設定 > 圖示與標誌。
-
儲存與發布時,伺服器會檢查值的格式與範圍,以及每一對顏色代碼的對比度(你沒有覆寫的代碼使用預設值;淺色與深色下都要達到 WCAG 2.2 AA)。只要有一項檢查未通過,就不會儲存或發布任何內容。
-
如果新版本重新命名或淘汰了某個代碼,或某個覆寫的值已不適合該代碼,升級不會因此失敗。該覆寫仍保留在已儲存的設定中,但不再生效:管理 API 會把它列在
stale_tokens底下,my instance theme get會指出它的名稱,下次儲存草稿時會將它捨棄。 -
已發布修訂的樣式表透過
/theme/{revision ID}.css提供(immutable,長期快取)。HTML 外殼有共用快取(60 秒加 300 秒的重新驗證),所以發布之後需要幾分鐘才會傳到所有人。已經開啟的頁面在重新載入之前維持舊的外觀。 -
外殼中的
<meta name="theme-color">(淺色與深色)以及 Web App Manifest 的theme_color/background_color(淺色)取主題的color-surface的值。從此之後,伺服器寄出的每封電子郵件的 HTML 版本都使用已發布主題的顏色(淺色與深色);草稿永遠不會影響電子郵件。 -
發布一組不含任何代碼的設定,會把主題重設為預設,樣式表也不再載入。
-
你可以用用戶端 API 與 CLI 更改它。用戶端 API 需要角色權限
manage_settings:GET /api/v1/admin/theme讀取草稿與生效中的設定,PUT /api/v1/admin/theme/draft儲存草稿,GET /api/v1/admin/theme/draft/stylesheet傳回草稿的樣式表以供預覽,POST /api/v1/admin/theme/publish與POST /api/v1/admin/theme/restore負責發布。發布會記錄在稽核日誌中(setting_changed,目標為theme)。
my instance theme get > theme.json # print the draft as the same JSON as the admin API (-published: the set in effect)my instance theme set < theme.json # save the whole draft (if a check fails, it prints why and changes nothing)my instance theme publish # publish the draftmy instance theme restore # publish again the set in effect before the current oneecho '{"tokens":[]}' | my instance theme set && my instance theme publish # back to the default{ "tokens": [ { "token": "color-accent", "light": "#ff8a80", "dark": "#ff8a80" }, { "token": "radius-control", "value": "0.25rem" } ]}除了縮圖和預覽圖片之外,實例還可以有自己的圖示、標誌和深色標誌,各自以一個 SVG 上傳。在設定之前,會使用內建的 mycroblog 圖片,清除後也會恢復內建圖片。
| 圖片 | 形狀 | 出現的位置 |
|---|---|---|
icon |
正方形(誤差 1% 以內) | 網站圖示(favicon)、iOS 的主畫面圖示(apple-touch-icon)、已安裝應用程式的圖示(Web App Manifest)、首頁上的伺服器卡片和網頁用戶端側邊面板中伺服器名稱旁,以及用戶端以正方形圖片顯示伺服器的任何地方 |
logo |
寬度為高度的 1 到 8 倍 | 網頁用戶端的頁首,以及登入、註冊和同意頁面的頂端,取代內建的文字標誌和伺服器名稱(標誌應包含名稱,名稱即為其替代文字)、每封電子郵件的 HTML 版本,以及未設定 preview_image 時的連結預覽圖片 |
logo_dark |
與 logo 相同 |
深色背景;沒有它時,那裡也使用 logo |
- 伺服器會清理 SVG。 它會將 SVG 當作 XML 讀取,並只用允許的元素(形狀、群組、
defs、symbol、use、漸層、clipPath、mask、pattern、style、title、desc)和屬性(幾何、變形、呈現屬性、id、class、style)寫出新的文件。指令碼、foreignObject、內嵌圖片、連結、動畫、濾鏡(陰影和模糊)、事件處理器、對檔案外部任何東西的參照,以及data:URL 都會被移除,回應中會列出被移除的項目。只有清理後的 SVG 會被儲存。 - 以下情況 SVG 會被拒絕(不會儲存任何東西):不是格式正確的 UTF-8 XML、含有
DOCTYPE或實體宣告、沒有viewBox、超過 256 KiB(清理後超過 128 KiB)、超過 5,000 個元素、巢狀深度超過 32 層、超過 200 個use元素、形狀不符合其種類、含有text(請先在編輯器中將文字轉為外框),或含有可能載入東西的 CSS(@import、@font-face、url(#id)以外的url()、跳脫字元)。允許在<style>中使用@media (prefers-color-scheme: dark),所以圖示可以在深色模式下改變。 - 有些地方不接受 SVG(iOS 主畫面、較舊 Safari 的網站圖示、連結預覽、電子郵件)。為此,上傳 SVG 的用戶端也會從清理後的 SVG 繪製 PNG 版本並一起送出:
icon為 32、48、180、192 和 512 px,以及一個 512 px 的 maskable 圖示;logo為高 96 px 的電子郵件標誌和 1200 × 630 的連結預覽圖片;logo_dark為高 96 px 的電子郵件標誌。伺服器會檢查每一個都是尺寸正確的 PNG(最多 1 MiB;180 px 圖示、maskable 圖示和連結預覽必須不透明),並在去除中繼資料後重新寫出。只要有任何一個檔案有誤,就不會儲存任何東西。圖示的不透明版本會繪製在背景色#rrggbb上,預設為主題的淺色color-surface。伺服器不會檢查 PNG 版本是否與 SVG 顯示相同的圖案。 - 檔案儲存在 blob 儲存區的
instance/brand/<revision>/之下,並以Cache-Control: public, max-age=31536000, immutable在https://<host>/brand/<revision>/<version>.svg|.png提供,因為修訂版本的內容永遠不會改變。SVG 會以Content-Security-Policy: default-src 'none'; style-src 'unsafe-inline'; sandbox和X-Content-Type-Options: nosniff提供,所以即使單獨開啟,它也不會執行或載入任何東西。先前修訂版本的檔案會保留,讓已寄出的電子郵件仍保有其標誌。 - 設定了圖示時,HTML 外殼會連結其 PNG 網站圖示、SVG 和 180 px 的
apple-touch-icon,Web App Manifest 會依序列出其 512 px、192 px、maskable 和 SVG 圖示(其他聯邦宇宙伺服器會將第一個當作這台伺服器的圖示),而/apple-touch-icon.png會回傳 180 px 的版本。外殼的 ETag 會隨圖片改變,外殼的共用快取和主題一樣會持續幾分鐘。已安裝的應用程式在 Android 上,會在 Chrome 下次檢查 manifest 時取得新圖示;在桌面上,應用程式在重新安裝之前會保留舊圖示。 GET /api/v1/instance會回傳icon、logo和logo_dark,附上 SVG 的 URL、每個 PNG 版本的 URL 和尺寸,以及修訂版本;使用內建圖片時則會省略。- 請在網頁用戶端的「伺服器設定」>「圖示與標誌」(
/admin/settings/branding,角色權限manage_settings)中設定。為圖示、標誌或深色背景用的標誌選擇一個 SVG 檔案:伺服器會立即檢查它,表單會以伺服器實際保留的樣子顯示它,並列出伺服器移除的項目。如果伺服器拒絕該檔案,原因及修正方式會顯示在它的下方。圖示的不透明版本的背景色也在那裡設定。「儲存」會在瀏覽器中繪製 PNG 版本,並將所選的每張圖片連同它們一起送出;「使用內建圖片」會在你儲存時讓圖片恢復為內建的圖片。網頁用戶端會保留已顯示過的圖片以供離線使用。 - 用戶端 API 也能做相同的事,需要角色權限
manage_settings:POST /api/v1/admin/instance/brand/sanitize會檢查 SVG,並回傳清理後的 SVG 以及要繪製的 PNG 版本(不會儲存任何東西),PUT /api/v1/admin/instance/brand/{icon|logo|logo_dark}會將 SVG 連同所有 PNG 版本一起儲存(multipart/form-data,每個版本一個部分),對同一路徑發出DELETE會清除其中一個,而GET /api/v1/admin/instance/brand會回傳目前的圖片以及圖示的背景色。每次變更都會保留為修訂版本(instance_brand_revisions),並記錄在稽核記錄中(setting_changed,目標為brand_icon、brand_logo或brand_logo_dark)。 - 由於 PNG 版本是由用戶端繪製的,CLI 無法設定它們,但可以顯示它們,並清除損壞的圖片:
my instance brand show # each image with its revision, when and by whom it was set, and the URL of its SVGmy instance brand clear icon # back to the built-in icon (also logo, logo_dark)自訂表情符號
Section titled “自訂表情符號”當有人在貼文的內文或內容警告中,或在顯示名稱、自我介紹或個人檔案欄位中寫下 :shortcode: 時,本站的自訂表情符號會以圖片顯示。它們也會透過你送出的 Note 和 actor 的 Emoji 標籤,送達 Mastodon、Misskey、GoToSocial 和 Akkoma。
- 短代碼為 2 到 30 個字母、數字或
_。它區分大小寫,表情符號註冊後就無法變更。別名(最多 10 個)和類別(最多 64 個字元)用於在表情符號選擇器中搜尋和分組。 - 圖片為 PNG、GIF 或 WebP,最大
custom_emoji_max_bytes(預設 256 KiB),每邊最多 1,024 px。伺服器會製作符合 64、128 和 256 px 方框的衍生圖片,不保留原始檔。APNG 會變成其第一個影格的靜態圖片。GoToSocial 預設不會擷取大於 100 KiB 的表情符號,所以建議使用小圖片。 - 停用的表情符號不會出現在任何地方(貼文、個人檔案、聯邦、選擇器),
:shortcode:會再次以文字顯示。設定為在選擇器中隱藏的表情符號只是不出現在選擇器中,仍可透過直接輸入來使用。來自其他伺服器的表情符號只能停用,或複製為這台伺服器的表情符號。 - 複製會在與媒體代理相同的限制下擷取其他伺服器表情符號的圖片(不會擷取設有
reject_media網域的圖片),執行與上述相同的檢查,並將其註冊為新的本站表情符號。短代碼為原本的短代碼,或你指定的短代碼。圖片會縮小到 256 px 的方框內,而無法擷取或未通過檢查的圖片不會留下任何東西。 - 刪除無法復原。過去貼文中的表情符號也會變回文字,再次註冊相同的短代碼會成為不同的表情符號。聯邦伺服器已複製的圖片無法刪除。
- 管理畫面(「自訂表情符號」,
/admin/custom-emojis)、用戶端 API(/api/v1/admin/custom_emojis)和 CLI 能做相同的事。在畫面上,「註冊表情符號」會開啟註冊表單(/admin/custom-emojis/new),其中會對超過 100 KiB 的圖片發出警告;在列表中選擇表情符號會開啟其頁面(/admin/custom-emojis/{id}),在那裡可以啟用或停用、替換圖片、變更類別、別名和選擇器中的顯示、輸入其短代碼後刪除,或複製其他伺服器的表情符號。管理畫面和用戶端 API 需要角色權限manage_custom_emojis(只有內建的admin擁有)。不論以何種方式進行,註冊、複製、替換圖片、變更設定和別名、啟用和停用,以及刪除,都會記錄在稽核記錄中(目標為custom_emoji)(從 CLI 進行的操作會記錄為 CLI 操作)。
my admin emoji create -shortcode blobcat -category Cats -alias neko blobcat.png # register onemy admin emoji list -local # list local emoji, newest firstmy admin emoji update -category Animals -alias cat -alias neko <emoji id> # change the category and aliases (aliases are replaced; -no-aliases removes them)my admin emoji update -hidden <emoji id> # hide it from the picker (-hidden=false restores it)my admin emoji replace-image <emoji id> blobcat2.png # replace the imagemy admin emoji disable <emoji id> # disable it (remote emoji too)my admin emoji enable <emoji id> # enable it againmy admin emoji list -remote -domain mastodon.example # list emoji of another servermy admin emoji copy [-shortcode <name>] <emoji id> # copy a remote emoji to localmy admin emoji delete <emoji id> # delete itmy admin emoji requests list [-state pending|approved|rejected|withdrawn|lapsed|all] # list creation requests (pending by default)my admin emoji requests approve <request id> # approve a requestmy admin emoji requests reject [-reason <text>] <request id> # reject a request (the requester sees the reason)- 擁有角色權限
create_custom_emojis(一項使用者功能)的使用者,可以從設定中的「自訂表情符號」(/settings/custom-emojis)申請建立表情符號、變更自己建立的表情符號的別名、類別和在選擇器中的顯示,以及刪除它們;該頁面會顯示他們這個月還剩下多少次申請。替換圖片也是一種申請,要透過用戶端 API 提出(POST /api/v1/custom_emoji_requests,kind為image);設定頁面不提供這項操作。申請在擁有manage_custom_emojis的人核准之前,不會出現在任何地方(選擇器、貼文、回應、聯邦)。請在管理畫面「自訂表情符號」的「申請」頁面(/admin/custom-emojis/requests)、透過用戶端 API(/api/v1/admin/custom_emoji_requests),或透過上述 CLI 核准或拒絕。擁有manage_custom_emojis的人會收到申請的通知(admin_custom_emoji_request),申請者則會收到核准或拒絕的通知。申請、撤回、核准和拒絕都會記錄在稽核記錄中(目標為custom_emoji_request)。 - 待處理的建立申請會保留其短代碼。在該申請被拒絕或撤回之前,無法以相同短代碼提出申請或進行註冊。已核准表情符號的圖片會被複製為實例 actor 的上傳檔案,所以即使申請者的帳號被刪除,它仍會保留。
- 建立者只有在持有
create_custom_emojis期間才能變更自己的表情符號。角色被移除後,表情符號仍會保留。管理員不論建立者是誰,都能變更和刪除所有表情符號。 - 當角色來自支持者方案時,使用者每月可建立的表情符號數量受方案的每月表情符號上限限制。它計算的是使用者在目前日曆月(UTC)內提出、已核准或待處理的建立申請;被拒絕和已撤回的申請不計入,刪除表情符號也不會釋出名額。申請計入其提出的月份,即使在下個月才被核准也一樣。計數會在每月第一天的 00:00 UTC 重設,設定頁面會以使用者自己的時區顯示重設時間。替換表情符號的圖片,以及管理員註冊的表情符號,都不計入。管理員手動指派的角色,以及停用支持者功能的伺服器,都沒有上限。
供 LLM 與程式設計代理使用:llms.txt,llms-full.txt, llms-small.txt