diff options
Diffstat (limited to 'docs/admin')
| -rw-r--r-- | docs/admin/admin_panel.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/admin/admin_panel.md b/docs/admin/admin_panel.md index da801f0d9..7443b5253 100644 --- a/docs/admin/admin_panel.md +++ b/docs/admin/admin_panel.md @@ -1,6 +1,6 @@ # Admin Control Panel -[gotosocial-admin](https://github.com/superseriousbusiness/gotosocial-admin) is a simple webclient that uses the [admin api routes](https://docs.gotosocial.org/en/latest/api/swagger/#operations-tag-admin) to manage your instance. It uses the same OAUTH mechanism as normal clients (with scope: admin), and as such can be hosted anywhere, separately from your instance, or run locally. A public installation is available here: [https://gts.superseriousbusiness.org/admin](https://gts.superseriousbusiness.org/admin). +The GoToSocial admin panel is a simple webclient that uses the [admin api routes](https://docs.gotosocial.org/en/latest/api/swagger/#operations-tag-admin) to manage your instance. It uses the same OAUTH mechanism as normal clients (with scope: admin), and as such can be hosted anywhere, separately from your instance, or run locally. A public installation is available here: [https://gts.superseriousbusiness.org/admin](https://gts.superseriousbusiness.org/admin). ## Using the panel To use the Admin API your account has to be promoted as such: @@ -16,11 +16,11 @@ any other client. You can change the instance's settings like the title and descriptions, and add/remove/change domain blocks including a bulk import/export. -## Installing the panel +## Building the panel Build requirements: some version of [Node.js](https://nodejs.org) and yarn. ``` -git clone https://github.com/superseriousbusiness/gotosocial-admin.git && cd gotosocial-admin -yarn install -node index.js +yarn install --cwd web/source +BUDO_BUILD=1 node web/source ``` -This will compile a static bundle in `public/`, which can be copied to any webhost, or put into your GoToSocial installation in the `web/admin` directory.
\ No newline at end of file + +See also: [Contributing.md Stylesheet / Web dev](https://github.com/superseriousbusiness/gotosocial/blob/main/CONTRIBUTING.md#stylesheet--web-dev)
\ No newline at end of file |