aboutsummaryrefslogtreecommitdiff
path: root/docs/administration/CLI_tasks/frontend.md
diff options
context:
space:
mode:
authorRoman Chvanikov <chvanikoff@pm.me>2020-07-20 17:31:05 +0300
committerRoman Chvanikov <chvanikoff@pm.me>2020-07-20 17:31:05 +0300
commit03a60c55fa61bf8583ce4f176cfabedd8b853ed0 (patch)
tree8d875bead745b91a3a120fbbcdbff10a5310d7a8 /docs/administration/CLI_tasks/frontend.md
parent76b0870496f5fc93262e7dbd67adb17e001cd81a (diff)
downloadpleroma-03a60c55fa61bf8583ce4f176cfabedd8b853ed0.tar.gz
Update docs
Diffstat (limited to 'docs/administration/CLI_tasks/frontend.md')
-rw-r--r--docs/administration/CLI_tasks/frontend.md28
1 files changed, 23 insertions, 5 deletions
diff --git a/docs/administration/CLI_tasks/frontend.md b/docs/administration/CLI_tasks/frontend.md
index 6c31bd660..b66ac14d3 100644
--- a/docs/administration/CLI_tasks/frontend.md
+++ b/docs/administration/CLI_tasks/frontend.md
@@ -1,9 +1,27 @@
# Managing frontends
-`mix pleroma.frontend install kenoma --ref=stable`
+`mix pleroma.frontend install <frontend> --path <path>`
-`develop` and `stable` refs are special: they are not necessarily `develop` or
-`stable` branches of the chosen frontend repo, but are smart aliases for either
-default branch of a frontend repo (develop), or latest release in a repo (stable).
-Only refs that have been built with Gitlab CI can be installed \ No newline at end of file
+Install locally built frontend.
+
+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)
+
+The complete process of installing frontend 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
+``` \ No newline at end of file