Update README.md (#45)

Updated some of the info and steps to get going. Added a guide on making first admin user.
This commit is contained in:
Felix the Cat 2022-03-15 16:06:22 -05:00 committed by GitHub
parent e3233f6b0c
commit 78e6ac4142
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -34,16 +34,16 @@ Create a folder for your Pleroma instance. Inside, you should have `Dockerfile`
Here is the `docker-compose.yml`. You should change the `POSTGRES_PASSWORD` variable. Here is the `docker-compose.yml`. You should change the `POSTGRES_PASSWORD` variable.
```yaml ```yaml
version: '2.3' version: '3.8'
services: services:
postgres: db:
image: postgres:9.6-alpine image: postgres:12.1-alpine
container_name: pleroma_postgres container_name: pleroma_db
restart: always restart: always
environment: environment:
POSTGRES_USER: pleroma POSTGRES_USER: pleroma
POSTGRES_PASSWORD: pleroma POSTGRES_PASSWORD: ChangeMe!
POSTGRES_DB: pleroma POSTGRES_DB: pleroma
volumes: volumes:
- ./postgres:/var/lib/postgresql/data - ./postgres:/var/lib/postgresql/data
@ -54,11 +54,21 @@ services:
container_name: pleroma_web container_name: pleroma_web
restart: always restart: always
ports: ports:
- '127.0.0.1:4000:4000' - '4000:4000'
volumes: volumes:
- ./uploads:/pleroma/uploads - ./uploads:/var/lib/pleroma/uploads
- ./static:/var/lib/pleroma/static
- ./config.exs:/etc/pleroma/config.exs:ro
environment:
DOMAIN: exmaple.com
INSTANCE_NAME: Pleroma
ADMIN_EMAIL: admin@example.com
NOTIFY_EMAIL: notify@example.com
DB_USER: pleroma
DB_PASS: ChangeMe!
DB_NAME: pleroma
depends_on: depends_on:
- postgres - db
``` ```
Create the upload and config folder and give write permissions for the uploads: Create the upload and config folder and give write permissions for the uploads:
@ -71,8 +81,8 @@ chown -R 911:911 uploads
Pleroma needs the `citext` PostgreSQL extension, here is how to add it: Pleroma needs the `citext` PostgreSQL extension, here is how to add it:
```sh ```sh
docker-compose up -d postgres docker-compose up -d db
docker exec -i pleroma_postgres psql -U pleroma -c "CREATE EXTENSION IF NOT EXISTS citext;" docker exec -i pleroma_db psql -U pleroma -c "CREATE EXTENSION IF NOT EXISTS citext;"
docker-compose down docker-compose down
``` ```
@ -157,6 +167,12 @@ Check if everything went well with:
docker logs -f pleroma_web docker logs -f pleroma_web
``` ```
Make a new admin user using docker exec (replace fakeadmin with any username you'd like):
```sh
docker exec -it pleroma_web sh ./bin/pleroma_ctl user new fakeadmin admin@test.net --admin
```
You can now setup a Nginx reverse proxy in a container or on your host by using the [example Nginx config](https://git.pleroma.social/pleroma/pleroma/blob/develop/installation/pleroma.nginx). You can now setup a Nginx reverse proxy in a container or on your host by using the [example Nginx config](https://git.pleroma.social/pleroma/pleroma/blob/develop/installation/pleroma.nginx).
### Update ### Update