Update readme
This commit is contained in:
parent
5f2966bacb
commit
848f616aa1
42
readme.md
42
readme.md
|
@ -1,12 +1,46 @@
|
||||||
# Pleroma on NixOS: OTP Release
|
# Pleroma on NixOS: OTP Release
|
||||||
|
|
||||||
## TODO
|
## Quick Start
|
||||||
|
|
||||||
- Add NixOS module.
|
Add your pleroma configuration to `/etc/pleroma/config.exs`, make sure
|
||||||
|
it's readable by the `pleroma` user.
|
||||||
|
|
||||||
## Minor Annoyances
|
You can then use the following example to get started.
|
||||||
|
|
||||||
We're retrieving the binary distribution directly from the GitLab CI pipeline.
|
```
|
||||||
|
```
|
||||||
|
|
||||||
|
## Pleroma Configuration Management
|
||||||
|
|
||||||
|
Pleroma is expecting its configuration to be found at
|
||||||
|
`/etc/pleroma/config.exs`. This configuration file is containing some
|
||||||
|
secrets, making impossible for it to live in the Nix store.
|
||||||
|
|
||||||
|
You'll have to create this file manually. Two options:
|
||||||
|
|
||||||
|
1. You are migrating a src-based install (mix-based). You can re-use
|
||||||
|
your `$src_root/config/prod.secret.exs` file. Change the `use Mix.Config`
|
||||||
|
statement with `use Config`.
|
||||||
|
2. This is a new installation. In that case you can use
|
||||||
|
`pleroma_ctl instance gen --output config.exs --output-psql setup.psql`,
|
||||||
|
this will prompt you some questions and will generate both your
|
||||||
|
config file and database initial migration. Note: `pleroma_ctl`
|
||||||
|
will be in your system path as soon as you enable the pleroma
|
||||||
|
service. You can alternatively build it by building this repo's
|
||||||
|
`default.nix` derivation.
|
||||||
|
|
||||||
|
## Pleroma Database Init
|
||||||
|
|
||||||
|
If it's not already done, you need to seed your pleroma postgresql database.
|
||||||
|
|
||||||
|
If you created your brand new pleroma configuration with
|
||||||
|
`pleroma_ctl instance gen --output-psql seed.psql`, you can load the
|
||||||
|
`seed.psql` dump to the database with `sudo -u pleroma psql -f seed.psql`.
|
||||||
|
|
||||||
|
## Update Pleroma to a New Version
|
||||||
|
|
||||||
|
We're retrieving the binary distribution directly from the GitLab CI
|
||||||
|
pipeline.
|
||||||
|
|
||||||
To find the latest and greatest bindist stable URL, you have to visit
|
To find the latest and greatest bindist stable URL, you have to visit
|
||||||
https://git.pleroma.social/pleroma/pleroma/-/tree/stable, clicky click
|
https://git.pleroma.social/pleroma/pleroma/-/tree/stable, clicky click
|
||||||
|
|
Loading…
Reference in a new issue