Skip to content

docs: update self-hosting guide with current Docker image and migration command #2714

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ddang175 wants to merge 1 commit into
base: master
Choose a base branch
from
+7 −6
Open

docs: update self-hosting guide with current Docker image and migration command #2714

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,10 @@ Setting up DKIM is highly recommended to reduce the chance your emails ending up
First you need to generate a private and public key for DKIM:

```bash
openssl genrsa -out dkim.key -traditional 1024
openssl genrsa -out dkim.key -traditional 1024 2>/dev/null || openssl genrsa -out dkim.key 1024
openssl rsa -in dkim.key -pubout -out dkim.pub.key
```
> **Note:** If you are using OpenSSL 3.x (e.g., Ubuntu 22.04+), the `-traditional` flag is required to generate a PKCS#1 key compatible with SimpleLogin. If you receive an error, ensure you are using OpenSSL 1.x or install it via `sudo apt install openssl1.0`.

You will need the files `dkim.key` and `dkim.pub.key` for the next steps.

Expand Down Expand Up @@ -434,7 +435,7 @@ docker run --rm \
-v $(pwd)/dkim.pub.key:/dkim.pub.key \
-v $(pwd)/simplelogin.env:/code/.env \
--network="sl-network" \
simplelogin/app:3.4.0 flask db upgrade
simplelogin/app:latest alembic upgrade head
```

This command could take a while to download the `simplelogin/app` docker image.
Expand All @@ -449,7 +450,7 @@ docker run --rm \
-v $(pwd)/dkim.key:/dkim.key \
-v $(pwd)/dkim.pub.key:/dkim.pub.key \
--network="sl-network" \
simplelogin/app:3.4.0 python init_app.py
simplelogin/app:latest python init_app.py
```

Now, it's time to run the `webapp` container!
Expand All @@ -465,7 +466,7 @@ docker run -d \
-p 127.0.0.1:7777:7777 \
--restart always \
--network="sl-network" \
simplelogin/app:3.4.0
simplelogin/app:latest
```

Next run the `email handler`
Expand All @@ -481,7 +482,7 @@ docker run -d \
-p 127.0.0.1:20381:20381 \
--restart always \
--network="sl-network" \
simplelogin/app:3.4.0 python email_handler.py
simplelogin/app:latest python email_handler.py
```

And finally the `job runner`
Expand All @@ -496,7 +497,7 @@ docker run -d \
-v $(pwd)/dkim.pub.key:/dkim.pub.key \
--restart always \
--network="sl-network" \
simplelogin/app:3.4.0 python job_runner.py
simplelogin/app:latest python job_runner.py
```

### Nginx
Expand Down