Mirrors/astuto
1
0
Fork 0
mirror of https://github.com/astuto/astuto.git synced 2025-12-16 11:47:56 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README (#384)

Browse Source
This commit is contained in:
Riccardo Graziosi
2024-07-16 20:18:44 +02:00
committed by GitHub
parent 6697020816
commit 964c6d69f4
1 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -34,17 +34,21 @@ With the paid plan:
- You get priority support - You get priority support
- You support open source and get our eternal gratitude :) - You support open source and get our eternal gratitude :)
### Self-hosted ### Self-hosted
Read the [Deploy with Docker instructions](https://docs.astuto.io/deploy-docker) for the most comprehensive and up to date guide on installing and configuring Astuto.
What you find below are minimal instructions to get you started as quickly as possible:
0. Ensure you have Docker and Docker Compose installed 0. Ensure you have Docker and Docker Compose installed
1. Create an empty folder 1. Create an empty folder
2. Inside that folder, create a `docker-compose.yml` file with the following content: 2. Inside that folder, create a `docker-compose.yml` file with the following content:
``` ```
version: '3.4'
services: services:
db: db:
image: postgres:14.5 image: postgres:14.5
environment: environment: &db-env
POSTGRES_USER: yourpostgresusername POSTGRES_USER: yourpostgresusername
POSTGRES_PASSWORD: yourpostgrespassword POSTGRES_PASSWORD: yourpostgrespassword
volumes: volumes:
@@ -52,8 +56,7 @@ services:
web: web:
image: riggraz/astuto:latest image: riggraz/astuto:latest
environment: environment:
POSTGRES_USER: yourpostgresusername <<: *db-env
POSTGRES_PASSWORD: yourpostgrespassword
BASE_URL: http://yourwebsite.com BASE_URL: http://yourwebsite.com
SECRET_KEY_BASE: yoursecretkeybase SECRET_KEY_BASE: yoursecretkeybase
ports: ports:
@@ -64,12 +67,9 @@ services:
volumes: volumes:
dbdata: dbdata:
``` ```
3. Edit the environment variables to fit your needs. You can find more information about env variables in the [documentation](https://docs.astuto.io/deploy-docker#2-edit-the-environment-variables-in-the-docker-compose-file). 3. Edit the environment variables to fit your needs. You can find more information about env variables in the [documentation](https://docs.astuto.io/deploy-docker/#2-edit-environment-variables).
4. Run `docker compose pull` 4. Run `docker compose pull && docker compose up`
5. Run `docker compose up` 5. You should now have a running instance of Astuto on port 3000. A default user account has been created with credentials email: `admin@example.com`, password: `password`.
6. You should now have a running instance of Astuto on port 3000. A default user account has been created with credentials email: `admin@example.com`, password: `password`.
**Note**: if you are on Linux and you encounter permission denied errors when running Docker commands, try to run them as administrator.
## Documentation ## Documentation