You need the following to get Aventum up and running:
If you have Docker then you will not need any of the following, for more info please check the Installation section!
mongo.envfiles, simply create a copy from one of those files and name it
.envand change the values to suit your need.
.env.productiondepends on the environment, just create your copy from them and name them like
.env.production.localand change the configurations as you want.
Aventum tested and support SQL based databases like PostgreSQL/MySQL/MariaDB and MongoDB.
Since Aventum uses Knex.js under the hood as a query builder for the SQL based databases so it should work with other SQL based databases that Knex.js supports like MSSQL, SQLite3, Oracle, and Amazon Redshift however we didn't test it yet with these databases(any contribution in this area will be more than welcome).
We included two sample configuration files
mongo.env, you can choose any of these files and create a copy from it with a name like
.env, Aventum server uses dotenv-flow behind the scenes to parse these
You can set a configuration file per environment like
.env.production, here are what these environment variables mean:
DB_TYPEthe database type that you want to use e.g.
mysqlfor MySQL and MariaDB, and
DB_NAMEthe database name.
DB_USERthe database user.
DB_PASSWORDthe database password.
DB_HOSTthe database host.
DB_PORTthe database port.
PORTthe port that the server will run on.
REDIS_FAMILY4 (IPv4) or 6 (IPv6).
SHOW_ERRORSNOT FULL USED AT THE MOMENT.
Aventum dashboard bootstrapped with create-react-app the file that picked depends on the environment, so there are three different files:
Create your copies from these files and name them like
.env.production.local and change the values in these files to suits your needs, each of these files contains
REACT_APP_BASE_URL environment variable which you can use to set up the Aventum server URL and
PORT environment variable which is the port that the dashboard will use in the development mode for example.