fix: install admin-fe from the package registry
This commit is contained in:
parent
04528f29d0
commit
a03e5df39c
5 changed files with 30 additions and 2 deletions
|
|
@ -76,6 +76,28 @@ The resulting frontend will always be installed into a folder of this template:
|
|||
|
||||
Careful: This folder will be completely replaced on installation.
|
||||
|
||||
## Installing Admin-FE
|
||||
|
||||
Install the latest published `develop` build using the configured package URL:
|
||||
|
||||
=== "OTP"
|
||||
|
||||
```sh
|
||||
./bin/pleroma_ctl frontend install admin-fe --ref develop
|
||||
# Or pin a release (replace <published-tag> with its exact tag):
|
||||
./bin/pleroma_ctl frontend install admin-fe --ref <published-tag>
|
||||
```
|
||||
|
||||
=== "From Source"
|
||||
|
||||
```sh
|
||||
mix pleroma.frontend install admin-fe --ref develop
|
||||
# Or pin a release (replace <published-tag> with its exact tag):
|
||||
mix pleroma.frontend install admin-fe --ref <published-tag>
|
||||
```
|
||||
|
||||
Use `--ref stable` for the latest published stable branch build, or replace `develop` with an exact published release tag to pin a version. The ref selects the package version in `https://git.pleroma.social/api/packages/pleroma/generic/admin-fe-builds/${ref}/latest.zip`; it must have a published package. The archive's `dist/` directory matches the default build directory, so no `--build-url` or `--build-dir` override is needed.
|
||||
|
||||
## Example installation for an unknown frontend
|
||||
|
||||
The installation process is the same, but you will have to give all the needed options on the command line. For example:
|
||||
|
|
|
|||
|
|
@ -56,7 +56,7 @@ Due to aforementioned bug, preferred way of installing frontends in AdminFE is b
|
|||

|
||||
and filling in the fields. Unfortunately AdminFE does not provide the raw data necessary for you to fill those fields, so your best bet is to see what backend returns in browser's devtools or refer to the [source code](https://git.pleroma.social/pleroma/pleroma/-/blob/develop/config/config.exs?ref_type=heads#L742-791). For the most part, only **Name**, **Ref** (i.e. version) and **Build URL** fields are required, although some frontends might also require **Build Directory** to work.
|
||||
|
||||
For pleroma-fe you can use either `master` or `develop` refs, or potentially any ref in GitLab that has artifacts for `build` job, but that's outside scope of this document.
|
||||
Pleroma-FE and Admin-FE builds are downloaded from the generic package registry rather than GitLab job artifacts. For Admin-FE, set **Name** to `admin-fe` and **Build URL** to `https://git.pleroma.social/api/packages/pleroma/generic/admin-fe-builds/${ref}/latest.zip`. Set **Ref** to `develop` or `stable` for the latest published build of that branch, or to an exact published release tag to pin a version. Only refs with a published package are installable; an arbitrary Git ref is not enough. The archive contains a `dist/` directory, so use `dist` as **Build Directory** (the backend default).
|
||||
|
||||
### Selecting default frontend
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue