diff options
Diffstat (limited to 'docs/administration/CLI_tasks/frontend.md')
-rw-r--r-- | docs/administration/CLI_tasks/frontend.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/administration/CLI_tasks/frontend.md b/docs/administration/CLI_tasks/frontend.md new file mode 100644 index 000000000..b1e0892bf --- /dev/null +++ b/docs/administration/CLI_tasks/frontend.md @@ -0,0 +1,47 @@ +# Managing frontends + +`mix pleroma.frontend install <frontend> [--path <path>] [--develop] [--ref <ref>]` + +Frontend can be installed either from local path with compiled sources, or from web. + +If installing from web, make sure you have [yarn](https://yarnpkg.com/getting-started/install) +since it's needed to build frontend locally. When no `--develop` or `--ref <ref>` +options passed, latest stable frontend will be installed. + +If installing from local path, building of sources is up to you. + +Currently supported `<frontend>` values: +- [admin](https://git.pleroma.social/pleroma/admin-fe) +- [kenoma](http://git.pleroma.social/lambadalambda/kenoma) +- [mastodon](http://git.pleroma.social/pleroma/mastofe) +- [pleroma](http://git.pleroma.social/pleroma/pleroma-fe) + +## Example installation from local path +The complete process of installing frontend from local path would be following: +- download a frontend: + +```bash +git clone https://git.pleroma.social/pleroma/pleroma-fe.git +``` +- build the frontend +```bash +cd pleroma-fe && yarn && yarn build +``` +- run the following command inside your Pleroma instance root directory: +```bash +mix pleroma.frontend install pleroma --path /path/to/pleroma-fe +``` + +## Example installation from web +The complete process of installing frontend from web would be following: +- make sure you've got `yarn` installed: + +```bash +yarn -v +``` + +- run the following command inside your Pleroma instance root directory to +install latest develop frontend: +```bash +mix pleroma.frontend install pleroma --develop +```
\ No newline at end of file |