diff --git a/README.md b/README.md index 88d7c5df..98b0411f 100644 --- a/README.md +++ b/README.md @@ -111,6 +111,15 @@ These packages are used to verify the setup. Install them by: sudo apt install -y dnsutils ``` +Create a directory to store SimpleLogin data: + +```bash +mkdir sl +mkdir sl/pgp # to store PGP key +mkdir sl/db # to store database +``` + + ### DKIM @@ -285,6 +294,7 @@ sudo docker run -d \ -e POSTGRES_USER=myuser \ -e POSTGRES_DB=simplelogin \ -p 5432:5432 \ + -v $(pwd)/sl/db:/var/lib/postgresql/data \ --restart always \ --network="sl-network" \ postgres:12.1 @@ -452,6 +462,8 @@ DKIM_PUBLIC_KEY_PATH=/dkim.pub.key DB_URI=postgresql://myuser:mypassword@sl-db:5432/simplelogin FLASK_SECRET=put_something_secret_here + +GNUPGHOME=/sl/pgp ``` @@ -460,6 +472,7 @@ Before running the webapp, you need to prepare the database by running the migra ```bash sudo docker run --rm \ --name sl-migration \ + -v $(pwd)/sl:/sl \ -v $(pwd)/dkim.key:/dkim.key \ -v $(pwd)/dkim.pub.key:/dkim.pub.key \ -v $(pwd)/simplelogin.env:/code/.env \ @@ -474,6 +487,7 @@ Now, it's time to run the `webapp` container! ```bash sudo docker run -d \ --name sl-app \ + -v $(pwd)/sl:/sl \ -v $(pwd)/simplelogin.env:/code/.env \ -v $(pwd)/dkim.key:/dkim.key \ -v $(pwd)/dkim.pub.key:/dkim.pub.key \ @@ -488,6 +502,7 @@ Next run the `email handler` ```bash sudo docker run -d \ --name sl-email \ + -v $(pwd)/sl:/sl \ -v $(pwd)/simplelogin.env:/code/.env \ -v $(pwd)/dkim.key:/dkim.key \ -v $(pwd)/dkim.pub.key:/dkim.pub.key \ diff --git a/docs/upgrade.md b/docs/upgrade.md index 882fd335..4454c4e7 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -56,7 +56,7 @@ for user in User.query.all(): ```bash # Pull the latest version -sudo docker pull simplelogin/app:2.0.0 +sudo docker pull simplelogin/app:2.1.0 # Stop SimpleLogin containers sudo docker stop sl-email sl-migration sl-app @@ -67,31 +67,34 @@ sudo docker rm -f sl-email sl-migration sl-app # Run the database migration sudo docker run --rm \ --name sl-migration \ + -v $(pwd)/sl:/sl \ -v $(pwd)/dkim.key:/dkim.key \ -v $(pwd)/dkim.pub.key:/dkim.pub.key \ -v $(pwd)/simplelogin.env:/code/.env \ --network="sl-network" \ - simplelogin/app:2.0.0 flask db upgrade + simplelogin/app:2.1.0 flask db upgrade # Run the webapp container sudo docker run -d \ --name sl-app \ + -v $(pwd)/sl:/sl \ -v $(pwd)/simplelogin.env:/code/.env \ -v $(pwd)/dkim.key:/dkim.key \ -v $(pwd)/dkim.pub.key:/dkim.pub.key \ -p 7777:7777 \ --restart always \ --network="sl-network" \ - simplelogin/app:2.0.0 + simplelogin/app:2.1.0 # Run the email handler container sudo docker run -d \ --name sl-email \ + -v $(pwd)/sl:/sl \ -v $(pwd)/simplelogin.env:/code/.env \ -v $(pwd)/dkim.key:/dkim.key \ -v $(pwd)/dkim.pub.key:/dkim.pub.key \ -p 20381:20381 \ --restart always \ --network="sl-network" \ - simplelogin/app:2.0.0 python email_handler.py + simplelogin/app:2.1.0 python email_handler.py ```