groot/automatisch
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Add docker installation section

Browse Source
This commit is contained in:
Faruk AYDIN
2022-12-05 16:43:31 +01:00
parent 67964192de
commit 22dc61f39b
1 changed files with 82 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
packages/docs/pages/guide/installation.md
View File

@@ -1,6 +1,16 @@
# Installation
You can install Automatisch by using docker compose.
:::tip
You can use `user@automatisch.io` email address and `sample` password to login to Automatisch. You can also change your email and password later on from the settings page.
:::
:::danger
Please be careful with the `ENCRYPTION_KEY` and `APP_SECRET_KEY` environment variables. They are used to encrypt your credentials from third-party services. If you change them, you will not be able to access your connections and thus, your existing flows and connections will be useless.
:::
## Docker Compose
```bash
# Clone the repository
@@ -13,14 +23,81 @@ cd automatisch
docker compose -p automatisch up
```
## Let's discover!
✌️ That's it; you have Automatisch running. Let's check it out by browsing [http://localhost:3000](https://localhost:3000)
✌️ That's it; you have Automatisch running. Let's check it out by browsing `http://localhost:3000`
## Docker
:::tip
Automatisch comes with two services which are `main` and `worker`. They both use the same image and need to have the same environment variables except for the `WORKER` environment variable which is set to `true` for the worker service.
You can use `user@automatisch.io` email address and `sample` password to login to Automatisch. You can also change your email and password later on from the settings page.
::: warning
We give the sample environment variable files for the setup but you should adjust them to include your own values.
:::
To install the main:
```bash
docker run --env-file=./main.env automatischio/automatisch
```
::: details main.env
```bash
APP_ENV=production
HOST=
PROTOCOL=
PORT=
ENCRYPTION_KEY=
APP_SECRET_KEY=
POSTGRES_HOST=
POSTGRES_PORT=
POSTGRES_DATABASE=
POSTGRES_USERNAME=
POSTGRES_PASSWORD=
POSTGRES_ENABLE_SSL=
REDIS_HOST=
REDIS_PORT=
REDIS_USERNAME=
REDIS_PASSWORD=
REDIS_TLS=
```
:::
To install the worker:
```bash
docker run --env-file=./worker.env automatischio/automatisch
```
::: details worker.env
```bash
WORKER=true
APP_ENV=production
HOST=
PROTOCOL=
PORT=
ENCRYPTION_KEY=
APP_SECRET_KEY=
POSTGRES_HOST=
POSTGRES_PORT=
POSTGRES_DATABASE=
POSTGRES_USERNAME=
POSTGRES_PASSWORD=
POSTGRES_ENABLE_SSL=
REDIS_HOST=
REDIS_PORT=
REDIS_USERNAME=
REDIS_PASSWORD=
REDIS_TLS=
```
:::
## Production setup
If you need to change any other environment variables for your production setup, let's check out the [environment variables](/advanced/configuration#environment-variables) section of the configuration page.
## Let's discover!
If you see any problems while installing Automatisch, let us know via [github issues](https://github.com/automatisch/automatisch/issues) or our [discord server](https://discord.gg/dJSah9CVrC).