58 lines
1.8 KiB
Markdown
58 lines
1.8 KiB
Markdown
# Emails
|
|
ProVM
|
|
|
|
## Description
|
|
Grab attachments from emails by inbox.
|
|
* Choose what mailboxes to watch.
|
|
* Select messages that you want to grab attachments from.
|
|
* Download (or view in browser) (decrypted) attachments from messages.
|
|
|
|
## Requirements
|
|
|
|
* Docker with Docker Compose [https://www.docker.com/](https://www.docker.com/)
|
|
|
|
## Installation
|
|
|
|
1. Pull from repository
|
|
```
|
|
git pull git@git.provm.cl:Incoviba/emails.git
|
|
```
|
|
Change to latest release
|
|
```
|
|
git checkout release
|
|
```
|
|
2. Check the docker-compose.yml files
|
|
1. docker-compose.yml - central proxy container
|
|
2. api/docker-compose.yml - API container and database
|
|
3. cli/docker-compose.yml - CLI container that runs cron jobs
|
|
4. ui/docker-compose.yml - UI container
|
|
3. Generate the API Key
|
|
If you have openssl (comes with most linux distros) you can run this in terminal
|
|
```
|
|
echo API_KEY=`(openssl rand -hex 128)` >> .key.env
|
|
```
|
|
4. Check Environment files
|
|
1. .env - Docker Compose and Environment settings. Check volumes and ports.
|
|
2. .key.env - API_KEY, generated before.
|
|
3. .mail.env - Email Identification.
|
|
4. api/.env - Encrypted PDF files passwords.
|
|
5. api/.db.env - Database configuration.
|
|
6. cli/.env - API_URI, for connecting to the api container from the cli container. Change it if the api is someplace else.
|
|
7. ui/.env - API_URI, same as from the cli.
|
|
5. Check if every configuration is correct before starting the application
|
|
```
|
|
docker compose config
|
|
```
|
|
If everything is fine
|
|
```
|
|
docker compose up -d
|
|
```
|
|
6. Connect to the UI
|
|
Default [http://localhost:8000](http://localhost:8000)
|
|
|
|
## Development
|
|
When development there is a container for adminer, to use it you can add it into `COMPOSE_PROFILES` or run
|
|
```
|
|
docker compose up -d adminer
|
|
```
|