Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit dcd2d853 authored by Felix Ableitner's avatar Felix Ableitner
Browse files

Improve .env file documentation (ref #68)

parent 240e0273

deployment/questionnaire/questionnaire.dat

+0 −2
Original line number Diff line number Diff line
@@ -18,7 +18,6 @@ PFDB_DB=postfix;default 
PFDB_USR=postfix;default

MYSQL_ROOT_PASSWORD=@@@generate@@@:20@

DBPASS=@@@generate@@@:20@

DBA_PASSWORD=@@@generate@@@:16@

DRIVE_SMTP_PASSWORD=@@@generate@@@:16@

POSTFIXADMIN_SSH_PASSWORD=@@@generate@@@:20@

CREATE_ACCOUNT_PASSWORD=@@@generate@@@:20@
@@ -28,7 +27,6 @@ PFA_SUPERADMIN_PASSWORD=1@@@generate@@@:16@2 
# fixed defaults

ENABLE_POP3=false;default

DISABLE_RATELIMITING=false;default

DBA_USER=phpmyadmin;default



# To be constructed repo specific

#SMTP_FROM=welcome@domainA.com

docs/env_file.md

+35 −25
Original line number Diff line number Diff line 
# .env File Documentation



In the following, `example.com` always stands for your domain that you are using with ecloud

selfhosting (ie, the domain you entered during setup).



## General configuration

```

```bash

DOMAIN=example.com # the main domain for your installation

ADD_DOMAINS=example.com, example2.com # one or more domains that are used for email

ALT_EMAIL=myname@gmail.com # admin email address

ALT_EMAIL=myname@some-other-domain.com # admin email address

INSTALL_ONLYOFFICE=n # y or n, whether Onlyoffice is installed

```



## Nextcloud

```

NEXTCLOUD_ADMIN_USER=ncadmin_z5BL

NEXTCLOUD_ADMIN_PASSWORD=sxOY26y0wKm1Q8SGhqmZ

```bash

NEXTCLOUD_ADMIN_USER=ncadmin_z5BL # username to login as Nextcloud admin

NEXTCLOUD_ADMIN_PASSWORD=sxOY26y0wKm1Q8SGhqmZ # password to login as Nextcloud admin

```



## Mail

```

RSPAMD_PASSWORD=gsteZuLgWLUNCs5b1Ksz

SMTP_PW=wGfQsTXPD3Ipm8Lfyk8y

PFA_SUPERADMIN_PASSWORD=1oyHLEWikVlKx0bz72

DISABLE_RATELIMITING=false

DRIVE_SMTP_PASSWORD=FL8D6SRnRWOdyMsN

ENABLE_POP3=false

VIRTUAL_HOST=autoconfig.domaina.pw,autodiscover.domaina.pw

```bash

RSPAMD_PASSWORD=gsteZuLgWLUNCs5b1Ksz # login to spam.example.com

PFA_SUPERADMIN_PASSWORD=1oyHLEWikVlKx0bz72 # password to create or change postfixadmin admin accounts

DISABLE_RATELIMITING=false # you can optionally disable rate limits for the mailserver

DRIVE_SMTP_PASSWORD=FL8D6SRnRWOdyMsN # password to send emails from drive@example.com

ENABLE_POP3=false # whether email retrieval via pop3 (port 110) should be enabled

VIRTUAL_HOST=autoconfig.example.com,autodiscover.example.com # additional domains for email sending/receiving

SMTP_HOST=mail.example.com # domain where the mailserver is running

```



## Database

```bash

MYSQL_USER_NC=nc_0VwU # mysql user for Nextcloud

MYSQL_PASSWORD_NC=LxsjA8bzNuzUcTYtkfof # mysql password for Nextcloud

MYSQL_DATABASE_NC=ncdb_aJWW # mysql database for Nextcloud

PFDB_DB=postfix # mysql database for postfixadmin

PFDB_USR=postfix # mysql database for postfixadmin

MYSQL_ROOT_PASSWORD=RqT9WkfrZ9e6SzX2ARoN # password for mysql root user

DBPASS=QPpTpgFkLFA2ABPizXwk # generic database password (used by multiple services)

```

MYSQL_USER_NC=nc_0VwU

MYSQL_PASSWORD_NC=LxsjA8bzNuzUcTYtkfof

MYSQL_DATABASE_NC=ncdb_aJWW

PFDB_DB=postfix

PFDB_USR=postfix

MYSQL_ROOT_PASSWORD=RqT9WkfrZ9e6SzX2ARoN

DBPASS=QPpTpgFkLFA2ABPizXwk

DBA_USER=phpmyadmin

DBA_PASSWORD=T1N2tYn7aDILXYNS

```

VHOSTS_ACCOUNTS=welcome.domaina.pw

SMTP_FROM=welcome@domaina.pw



## Signup

Note: To create new accounts, you need to generate an invite link with `scripts/generate-signup-link.sh` first.

```bash

VHOSTS_ACCOUNTS=welcome.example.com # domain used for signup service

SMTP_FROM=welcome@example.com # email used to send welcome message to new users

SMTP_PW=wGfQsTXPD3Ipm8Lfyk8y # password used to send welcome messages to new users

POSTFIXADMIN_SSH_PASSWORD=9uKDFMiO25AVVDhEdSnU # password used by create-account container to access postfixadmin container via ssh

CREATE_ACCOUNT_PASSWORD=sOmqLjsnLTDYw2dJPs1q # internal password needed to send requests to create-account container

```