[{"data":1,"prerenderedAt":505},["ShallowReactive",2],{"navigation_en":3,"GNoScript_0tnecEo1zGdmG08nE5nADngdwGJ9a2VAQnh88Hft8":454,"docs-en-for-developers":461,"content-navigation-r0bzOhmv8s":464},[4],{"title":5,"_path":6,"children":7},"En","/en",[8],{"title":9,"_path":10,"children":11},"Docs","/en/docs",[12,16,217,331,436,440,443,446,450],{"title":13,"_path":14,"description":15},"About Misskey","/en/docs/about-misskey","Documentation about Misskey.",{"title":17,"_path":18,"children":19,"description":22},"For Misskey Users","/en/docs/for-users",[20,23,45,170,198],{"title":21,"_path":18,"description":22},"User Guide","This section provides an overview of general features that are useful for both new and existing Misskey users.",{"title":24,"_path":25,"children":26,"description":28},"Getting Started with Misskey","/en/docs/for-users/onboarding",[27,29,33,37,41],{"title":24,"_path":25,"description":28},"Here you will find a tutorial to get you started in Misskey.",{"title":30,"_path":31,"description":32},"Important notes","/en/docs/for-users/onboarding/warning","Those are some basic notes before creating an account on a Misskey server.",{"title":34,"_path":35,"description":36},"Find a Misskey Server","/en/docs/for-users/onboarding/get-started","This section explains user registration on a Misskey server and basic operations.",{"title":38,"_path":39,"description":40},"Register on a server","/en/docs/for-users/onboarding/join-server","Once you have decided which server to register with, it's time to create an account.",{"title":42,"_path":43,"description":44},"Misskey Basics","/en/docs/for-users/onboarding/things-to-know","Welcome, newcomers! We've put together some basic Misskey knowledge to help you get started right away.",{"title":46,"_path":47,"children":48,"description":50},"Various functions","/en/docs/for-users/features",[49,51,55,59,63,67,71,75,79,83,87,91,95,99,103,107,111,115,119,123,127,131,135,139,143,147,151,155,159,162,166],{"title":46,"_path":47,"description":50},"We will explain many functions that are the main feature of Misskey.",{"title":52,"_path":53,"description":54},"Ads","/en/docs/for-users/features/ads","Misskey has a feature that displays ads etc.",{"title":56,"_path":57,"description":58},"Antennas","/en/docs/for-users/features/antenna","Antennas are a function of Misskey that collects notes that match the set conditions.",{"title":60,"_path":61,"description":62},"Charts","/en/docs/for-users/features/charts","Misskey has a feature that displays and generates charts from various server data sources.",{"title":64,"_path":65,"description":66},"Clips","/en/docs/for-users/features/clip","Clips are a feature of Misskey that summarize notes. Clips are a feature of Misskey that summarize notes. They don't care if the notes are mine or someone else's. You can make more than one clips, and you can name them and give an explanation, and you can manage them. You can also choose between public and private clips. You can also choose between public and private clips.",{"title":68,"_path":69,"description":70},"Custom Emoji","/en/docs/for-users/features/custom-emoji","Custom Emoji is a feature that allows you to use images uploaded to the instance as emoji. They can be used in places such as notes, reactions, chat, self-introductions, and names. To use a custom emoji in those places, press the emoji picker button (if present) or type : to display emoji suggestions. If a string of the form :foo: is found in the text, the foo part is interpreted as a custom emoji name and replaced by the corresponding custom emoji when displayed.",{"title":72,"_path":73,"description":74},"Deck","/en/docs/for-users/features/deck","Deck is one of the available UIs. It features the ability to create highly customizable and dense UIs by displaying multiple views side by side called \"columns.\"\nIn addition, when notes or profiles are displayed on the page, if a main column is added then their contents will be displayed inside it.",{"title":76,"_path":77,"description":78},"Developer Mode","/en/docs/for-users/features/dev-mode","Developer Mode can be enabled from Settings > Other > Developer. Developer Mode enables features useful for developers, such as the ability to copy a note ID from a note's context menu.",{"title":80,"_path":81,"description":82},"Drive","/en/docs/for-users/features/drive","Drive is a feature to manage the files you have uploaded to Misskey.",{"title":84,"_path":85,"description":86},"Embed to Website","/en/docs/for-users/features/embed","You can embed notes and timelines on the Misskey server into your website.\nWith Misskey, widgets design is highly customizable so you can fit them to your website.",{"title":88,"_path":89,"description":90},"Bookmarks","/en/docs/for-users/features/favorite","This function allows you to save notes as bookmarks.",{"title":92,"_path":93,"description":94},"Follow","/en/docs/for-users/features/follow","When you follow a user, you will see their posts on your timeline. However, this does not include replies to other users.",{"title":96,"_path":97,"description":98},"Hashtags","/en/docs/for-users/features/hashtag","Hashtag is a feature that allows you to add searchable tags to your posts.",{"title":100,"_path":101,"description":102},"Mentions","/en/docs/for-users/features/mention","You can mention users by including their username with an @ symbol in the note (e.g. @user@misskey.example). Mentioned users will receive a notification that they've been mentioned.",{"title":104,"_path":105,"description":106},"MFM","/en/docs/for-users/features/mfm","MFM is a proprietary markup language that can be used in various locations in Misskey.",{"title":108,"_path":109,"description":110},"Mutes and Blocks","/en/docs/for-users/features/mute-and-block","If you don't like someone, you can mute them so they're no longer visible to you. Or, as a more powerful measure, you can block someone so they can't see your content or interact with you. The other person won't know that they are muted, but they will know that they are blocked. It is up to you to decide which one to use.",{"title":112,"_path":113,"description":114},"Notes","/en/docs/for-users/features/note","Notes are the main content of Misskey. They can consist of images, texts, polls, and more. On other platforms, notes are known as posts.",{"title":116,"_path":117,"description":118},"Online Status","/en/docs/for-users/features/online-status","A user's Online Status is an indication of the user's Misskey usage status.\nThe online status is displayed as an indicator in the corner of the user's icon on the user page, for example.",{"title":120,"_path":121,"description":122},"Page","/en/docs/for-users/features/pages","In addition to notes, you can create pages on Misskey.v13 specializes in static pages.",{"title":124,"_path":125,"description":126},"Plugins","/en/docs/for-users/features/plugin","Misskey Web has a plug-in feature that allows users to extend its functionality.",{"title":128,"_path":129,"description":130},"Polls","/en/docs/for-users/features/poll","Polls are a feature that allow you to solicit opinions from others.",{"title":132,"_path":133,"description":134},"Reactions","/en/docs/for-users/features/reaction","The reaction feature allows you to easily show your reactions to other people's notes using emoji. To react, click the + icon on the note and select an emoji from the picker. You can also react with custom emojis.",{"title":136,"_path":137,"description":138},"Safe Mode","/en/docs/for-users/features/safemode","Since Misskey Web v2025.8.0, Misskey features a Safe Mode which disables custom CSS, plugins, and themes. This is for cases where these features interfere with the normal operation of the app.",{"title":140,"_path":141,"description":142},"Share Form","/en/docs/for-users/features/share-form","On Misskey Web, the path /share leads to a social sharing form. This page is useful for external site owners who want users to share their pages on Misskey.",{"title":144,"_path":145,"description":146},"Silence","/en/docs/for-users/features/silence","An account can be in a silenced state.",{"title":148,"_path":149,"description":150},"Themes","/en/docs/for-users/features/theme","Themes can be used to change the look and feel of the Misskey client.",{"title":152,"_path":153,"description":154},"Mute Thread","/en/docs/for-users/features/thread-mute","",{"title":156,"_path":157,"description":158},"Timelines","/en/docs/for-users/features/timeline","Notes are shown in the timelines. There are several kinds of timelines as mentioned below and each of them displays the different set of notes. Servers might disable some of them.",{"title":160,"_path":161,"description":154},"Webhook","/en/docs/for-users/features/webhook",{"title":163,"_path":164,"description":165},"Widgets","/en/docs/for-users/features/widgets","Widgets are small displays that can be added to the Misskey UI to show and interact with information.",{"title":167,"_path":168,"description":169},"Word Mute","/en/docs/for-users/features/word-mute","When Word Mute is configured, a note that matches the conditions set in Word Mute will be minimized and shown as \"Username said something\". The contents of the note can be seen by clicking on the minimized note.",{"title":171,"_path":172,"children":173,"description":197},"Additional Resources","/en/docs/for-users/resources",[174,178,182,186,190,194],{"title":175,"_path":176,"description":177},"Troubleshooting","/en/docs/for-users/resources/troubleshooting","Check this page first when you are in trouble using Misskey.",{"title":179,"_path":180,"description":181},"Apps","/en/docs/for-users/resources/apps","Here are some apps to use with Misskey.",{"title":183,"_path":184,"description":185},"Frequently Asked Questions","/en/docs/for-users/resources/faq","This document contains frequently asked questions about using Misskey.",{"title":187,"_path":188,"description":189},"Glossary","/en/docs/for-users/resources/glossary","A glossary of terms related to Misskey.",{"title":191,"_path":192,"description":193},"Misskey Hub","/en/docs/for-users/resources/misskey-hub","Misskey Hub is the official website of the Misskey Project, which provides knowledge and other documentation about Misskey, a development blog, and a plugin store.\nIt aims to be \"the place to be for all things Misskey.\"",{"title":195,"_path":196,"description":154},"Self-XSS Attack","/en/docs/for-users/resources/self-xss","This section introduces non-functional knowledge and how to deal with problems.",{"title":199,"_path":200,"children":201,"description":216},"Step-by-step Guides","/en/docs/for-users/stepped-guides",[202,204,208,212],{"title":199,"_path":200,"description":203},"In this section, we'll explain some complicated things in Misskey by crunching into small steps.",{"title":205,"_path":206,"description":207},"How to delete your account","/en/docs/for-users/stepped-guides/how-to-delete-account","This page explains how to delete your account on Misskey server.",{"title":209,"_path":210,"description":211},"How to Set Up Two-Factor Authentication (One-Time Password)","/en/docs/for-users/stepped-guides/how-to-enable-2fa","This guide explains how to set up a one-time password for your Misskey account to enhance security.",{"title":213,"_path":214,"description":215},"How to use Misskey Web as a smartphone app","/en/docs/for-users/stepped-guides/how-to-use-pwa","Learn how to turn Misskey Web into a PWA app. This is the recommended way to use Misskey on your smartphone.","This page explains Misskey operations step by step in detail. Check out this section when you find yourself difficult using Misskey!",{"title":218,"_path":219,"children":220,"description":330},"For Server Operators","/en/docs/for-admin",[221,258,321],{"title":222,"_path":223,"children":224,"description":226},"Server Features","/en/docs/for-admin/features",[225,227,231,235,239,243,247,250,254],{"title":222,"_path":223,"description":226},"Features for server administrators.",{"title":228,"_path":229,"description":230},"通報","/en/docs/for-admin/features/abuse-report","Misskeyでは、サーバー内外のユーザーからサーバー内のコンテンツに関する通報を受け取ることができます。",{"title":232,"_path":233,"description":234},"Announcements","/en/docs/for-admin/features/announcement","Announcements are one of the features available in Misskey.",{"title":236,"_path":237,"description":238},"管理コマンド","/en/docs/for-admin/features/cli","2025.8.0以降のMisskeyでは、サーバー管理コマンドを利用できます。",{"title":240,"_path":241,"description":242},"連合モード","/en/docs/for-admin/features/federation","Misskeyは分散型プラットフォームとしてデフォルトでActivityPubによる連合をサポートしていますが、サーバーの運営方針などに応じて連合を限定的にしたり、無効化したりすることも可能です。",{"title":244,"_path":245,"description":246},"Fan-out Timeline Technology (FTT)","/en/docs/for-admin/features/ftt","FTT is one of the major server features available in Misskey.",{"title":248,"_path":249,"description":154},"Managing Custom Emojis","/en/docs/for-admin/features/managing-emojis",{"title":251,"_path":252,"description":253},"Roles","/en/docs/for-admin/features/role","Roles are attributes assigned to users that allow you to display badges and assign permissions using policy settings.",{"title":255,"_path":256,"description":257},"ノート検索","/en/docs/for-admin/features/search","Misskeyにはノートの検索機能があります。有効化することで、ノートの検索ができるようになります。",{"title":259,"_path":260,"children":261,"description":320},"Install and Maintain Misskey","/en/docs/for-admin/install",[262,291],{"title":263,"_path":264,"children":265,"description":267},"Creating a Misskey Server","/en/docs/for-admin/install/guides",[266,268,272,276,280,284,288],{"title":263,"_path":264,"description":267},"How to create a Misskey server.",{"title":269,"_path":270,"description":271},"Use Dedicated Service","/en/docs/for-admin/install/guides/service","Set up Misskey server with ease by using third-party service.",{"title":273,"_path":274,"description":275},"Misskey install shell script v3.0.0","/en/docs/for-admin/install/guides/bash","This shell script was made to make the installation of Misskey easy!",{"title":277,"_path":278,"description":279},"Building Misskey using Docker Compose","/en/docs/for-admin/install/guides/docker","This guide explains how to set up Misskey using Docker",{"title":281,"_path":282,"description":283},"Kubernetes/TrueNASを使ったMisskey構築","/en/docs/for-admin/install/guides/kubernetes","このガイドでは、Kubernetes と HelmChartを使用したMisskeyセットアップ方法について説明します。",{"title":285,"_path":286,"description":287},"Manual Misskey Installation","/en/docs/for-admin/install/guides/manual","This guide will tell you how to install and setting Misskey.",{"title":289,"_path":290,"description":154},"Ubuntu版Misskeyインストール方法詳説","/en/docs/for-admin/install/guides/ubuntu-manual",{"title":292,"_path":293,"children":294,"description":319},"Misskey Maintenance & Troubleshooting","/en/docs/for-admin/install/resources",[295,299,303,307,311,315],{"title":296,"_path":297,"description":298},"CDN Configuration","/en/docs/for-admin/install/resources/cdn","We strongly recommend using a CDN such as Cloudflare when publishing your Misskey server.",{"title":300,"_path":301,"description":302},"Notes on Forking and Customizing Misskey","/en/docs/for-admin/install/resources/forking","The GNU Affero General Public License v3.0 (AGPL-3.0), adopted by Misskey, mandates the disclosure of any modifications made to the Misskey source code.",{"title":304,"_path":305,"description":306},"Nginx configuration","/en/docs/for-admin/install/resources/nginx","We recommend using nginx as a reverse proxy and operating the Misskey server without exposing it directly to the Internet.\nThis provides the following benefits:",{"title":308,"_path":309,"description":310},"How to push to Docker Hub using GitHub Actions","/en/docs/for-admin/install/resources/push-docker-hub","An example of how to push to Docker Hub using Github Actions can be found on the original repository in the file /.github/workflows/docker.yml",{"title":312,"_path":313,"description":314},"Scaling Misskey","/en/docs/for-admin/install/resources/scale-out","As the number of your users increase, it becomes necessary to improve the specs of the server or increase the number of servers to handle the load. This article introduces tips on how to scale your Misskey server.",{"title":316,"_path":317,"description":318},"マニュアルインストール時のトラブルシューティング","/en/docs/for-admin/install/resources/troubleshooting","2018年10月07日 / 2021年12月20日 最終更新 / 文責 aqz/tamaina","Regular maintenance is essential to running a Misskey server. Here is some useful information about maintaining Misskey.","Information on how to install and subsequently maintain Misskey.",{"title":322,"_path":323,"children":324,"description":329},"Moderation Tips","/en/docs/for-admin/moderation-tips",[325],{"title":326,"_path":327,"description":328},"Disabling the LTL/STL/GTL","/en/docs/for-admin/moderation-tips/disable-timelines","In Misskey, it's possible to individually deactivate the LTL/STL/GTL. You can enable or disable these individual timelines via the instance control panel. You can enable or disable these individual timelines via the instance control panel.","Useful information for the practical management of the server.","Guides and resources on how to create a server and useful tips for operating a server.",{"title":332,"_path":333,"children":334,"description":435},"For Developers","/en/docs/for-developers",[335,339,408,414,431],{"title":336,"_path":337,"description":338},"AiScript","/en/docs/for-developers/aiscript","AiScript is a scripting language for Misskey that can be used in following features:",{"title":340,"_path":341,"children":342,"description":344},"Misskey API","/en/docs/for-developers/api",[343,345,348,352,356,390],{"title":340,"_path":341,"description":344},"Misskey has a public API.The API can be used for developing Misskey clients, Misskey connected web-services, bots, etc. (which will be referred to as \"applications\" from here on).",{"title":346,"_path":347,"description":154},"Endpoints","/en/docs/for-developers/api/endpoints",{"title":349,"_path":350,"description":351},"List of Libraries","/en/docs/for-developers/api/libraries","List of Misskey API libraries",{"title":353,"_path":354,"description":355},"List of permissions","/en/docs/for-developers/api/permission","Permissions required by the application",{"title":357,"_path":358,"children":359,"description":361},"ストリーミングAPI","/en/docs/for-developers/api/streaming",[360,362,387],{"title":357,"_path":358,"description":361},"ストリーミングAPIを使うと、リアルタイムで様々な情報(例えばタイムラインに新しい投稿が流れてきた、リアクションされた、フォローされた、など)を受け取ったり、様々な操作を行ったりすることができます。",{"title":363,"_path":364,"children":365,"description":154},"List of channels","/en/docs/for-developers/api/streaming/channel",[366,367,371,375,379,383],{"title":363,"_path":364,"description":154},{"title":368,"_path":369,"description":370},"globalTimeline","/en/docs/for-developers/api/streaming/channel/global-timeline","グローバルタイムラインのノートが流れるチャンネルです。",{"title":372,"_path":373,"description":374},"homeTimeline","/en/docs/for-developers/api/streaming/channel/home-timeline","ホームタイムラインのノートが流れるチャンネルです。",{"title":376,"_path":377,"description":378},"hybridTimeline","/en/docs/for-developers/api/streaming/channel/hybrid-timeline","ソーシャルタイムラインのノートが流れるチャンネルです。",{"title":380,"_path":381,"description":382},"localTimeline","/en/docs/for-developers/api/streaming/channel/local-timeline","ローカルタイムラインのノートが流れるチャンネルです。",{"title":384,"_path":385,"description":386},"main","/en/docs/for-developers/api/streaming/channel/main","基本的な情報が流れるチャンネルです。",{"title":388,"_path":389,"description":154},"投稿キャプチャイベント","/en/docs/for-developers/api/streaming/note-capture-events",{"title":391,"_path":392,"children":393,"description":395},"Obtain an access token","/en/docs/for-developers/api/token",[394,396,400,404],{"title":391,"_path":392,"description":395},"To get started with the API, you first need to get an access token tied to the account you want to use.\nThis document describes the steps to get an access token and then the basic API usage.",{"title":397,"_path":398,"description":399},"Obtaining an Access Token via MiAuth","/en/docs/for-developers/api/token/miauth","This document explains a simple authentication method unique to Misskey, available from v12.27.0 onwards.",{"title":401,"_path":402,"description":403},"Obtaining an Access Token via OAuth","/en/docs/for-developers/api/token/oauth","This document explains how to authenticate using the OAuth2.0 method, available from v2023.9.0 onwards.",{"title":405,"_path":406,"description":407},"Obtaining an Access Token by Creating an App (Legacy)","/en/docs/for-developers/api/token/app","This document explains how to obtain an access token in versions of Misskey prior to the introduction of MiAuth (before v12.27.0)",{"title":409,"_path":410,"children":411,"description":413},"Create a bot","/en/docs/for-developers/bot",[412],{"title":409,"_path":410,"description":413},"Misskey API can be used to develop a Bot.",{"title":415,"_path":416,"children":417,"description":430},"Creating a Plugin/Play","/en/docs/for-developers/plugin",[418,422,426],{"title":419,"_path":420,"description":421},"Create Play","/en/docs/for-developers/plugin/create-play","Play is a function that allows users to create their own mini-applications and games by building their own UI in AiScript.\nThe Play you create can be published on the server, and anyone can play with the Play you have created.",{"title":423,"_path":424,"description":425},"Creating Plugins","/en/docs/for-developers/plugin/create-plugin","The plugin feature of the Misskey Web Client allows you to extend the client and add various features to it.",{"title":427,"_path":428,"description":429},"AiScript Misskey Extended API Reference","/en/docs/for-developers/plugin/plugin-api-reference","This section introduces the AiScript API extended for Misskey.","Instructions on how to create Plugins and Plays can be found here.",{"title":432,"_path":433,"description":434},"Distributing Plugins and Themes","/en/docs/for-developers/publish-on-your-website","Starting with Misskey v2023.11.0, you can now install various additional resources directly from your website. This feature is especially useful for those who produce a lot of plugins and themes, and for those who want to create a plugin distribution website. This feature is especially useful for those who produce a lot of plugins and themes, and for those who want to create a plugin distribution website.","Resources for plugin and Play developers, as well as developers of external applications using the API.",{"title":437,"_path":438,"description":439},"Release Notes","/en/docs/releases","Release Notes for Misskey.",{"title":441,"_path":442,"description":154},"Donating to the project","/en/docs/donate",{"title":444,"_path":445,"description":154},"Become a Sponsor","/en/docs/become-a-sponsor",{"title":447,"_path":448,"description":449},"Misskey ID Card","/en/docs/mi-card","As a return for your generous and valuable support of the Misskey Project, you will receive a physical Misskey ID Card!",{"title":451,"_path":452,"description":453},"Misskey vs Misskey Servers","/en/docs/misskey-and-misskey-servers","Misskey is not the same as a Misskey server (Misskey instance).",["Island",455],{"key":456,"result":457},"GNoScript_0tnecEo1zGdmG08nE5nADngdwGJ9a2VAQnh88Hft8",{"head":458},{"link":459,"style":460},[],[],{"_path":462,"_dir":463},"/en/docs/for-developers/_dir",{"_path":462,"title":332,"description":435},[465],{"title":5,"_path":6,"children":466},[467],{"title":9,"_path":10,"children":468},[469],{"title":332,"_path":333,"children":470,"description":435},[471,472,496,499,504],{"title":336,"_path":337,"description":338},{"title":340,"_path":341,"children":473,"description":344},[474,475,476,477,478,490],{"title":340,"_path":341,"description":344},{"title":346,"_path":347,"description":154},{"title":349,"_path":350,"description":351},{"title":353,"_path":354,"description":355},{"title":357,"_path":358,"children":479,"description":361},[480,481,489],{"title":357,"_path":358,"description":361},{"title":363,"_path":364,"children":482,"description":154},[483,484,485,486,487,488],{"title":363,"_path":364,"description":154},{"title":368,"_path":369,"description":370},{"title":372,"_path":373,"description":374},{"title":376,"_path":377,"description":378},{"title":380,"_path":381,"description":382},{"title":384,"_path":385,"description":386},{"title":388,"_path":389,"description":154},{"title":391,"_path":392,"children":491,"description":395},[492,493,494,495],{"title":391,"_path":392,"description":395},{"title":397,"_path":398,"description":399},{"title":401,"_path":402,"description":403},{"title":405,"_path":406,"description":407},{"title":409,"_path":410,"children":497,"description":413},[498],{"title":409,"_path":410,"description":413},{"title":415,"_path":416,"children":500,"description":430},[501,502,503],{"title":419,"_path":420,"description":421},{"title":423,"_path":424,"description":425},{"title":427,"_path":428,"description":429},{"title":432,"_path":433,"description":434},1780651136338]