Cacao Accounting setup:
Following the the twelve factor app recommendations Cacao Accounting can be configured with enviroment variables.
This is a list of available options. es:
Required
| Option | Description | Examples / Comments |
|---|---|---|
| CACAO_DB | Database connection string. | See examples above |
| CACAO_KEY | Unique key to secure cookies. | Must contains uppercase, lowercase and numbers |
Optional
| Option | Description | Examples / Comments |
|---|---|---|
| CACAO_THREADS | CPU threads to use. | Default 4 |
| CACAO_PORT | POrt for the WSGI server to listen | Default 8080 |
| PYTHON_CPU_COUNT | Max CPU unit to use | Container only |
| CACHE_REDIS_URL | Redis service Connection String | Example: redis://localhost:6379/1 |
Initial Setup
The first time your run Cacao Accounting the following variables are used to set a custom master user, if not available default options will be used.
| Option | Description | Examples / Comments |
|---|---|---|
| CACAO_USER | Master user id |
Default cacao |
| CACAO_PSWD | Master user password |
Default cacao |
Warning
Default user and password are available in the app source code so it is advised always use custom user and password for the system master user.
Setup enviroment variables:
Linux
export CACAO_DB=DATABASE_CONNECTION_URI
export CACAO_KEY=SECRETKEY
Windows:
setx CACAO_DB "DATABASE_CONNECTION_URI"
setx CACAO_KEY "SECRETKEY"
Dockerfile
ENV CACAO_DB=DATABASE_CONNECTION_URI
ENV CACAO_KEY=SECRETKEY
Database Connection String
Info
Cacao Accounting is tested with SQLite, Postgresql and MySQL8, the system should work with MariaDB without changes but support for MariaDB must be considered experimental and not fully tested.
Postgresql :
pg8000
pg8000 is a pure Python Postgresql driver, it is the default option because not requieres a compilation process.
Examples:
postgresql+pg8000://usuario:contraseña@servidor:puerto/database
postgresql+pg8000://cacao:cacao@localhost:5432/cacao
psycopg2
psycopg2 is a compiled Python Postgresql driver, it is recommend to compile the driver with the same version of Postgresql you will using in production. The OCI image includes a compiled version of psycopg2 by default.
Examples:
postgresql+psycopg2://usuario:contraseña@servidor:puerto/database
postgresql+psycopg2://cacao:cacao@localhost:5432/cacao
MySQL :
Examples:
mysql+pymysql://ususario:contraseña@servidor:puerto/database
mysql+pymysql://cacao:cacao@localhost:3306/cacao
Note
The pymysql driver requieres the pyca/cryptography library to be available to connect to the database server, the required libraries
are incluyed by default in the OCI image, most of the time the pip with install the cryptography package apropiate for your
system you can check the installation documentarion for a list of all supported
platforms.
SQLite :
Warning
Never uses SQLIte in continer based deplyment since SQLite files are stored in the container file system and always the container file system is ephemeral and all the data stored in it will destroyed in the next deployment.
sqlite://cacaoaccounting.db