Project setup¶
Clone MyCivitas repository¶
This will clone the MyCivitas repository to your machine
Set up the project¶
This will set up the MyCivitas project on your machine
cd mycivitas
cd deployment
cp docker-compose.override.template.yml docker-compose.override.yml
cp sites-enabled/default.conf.template sites-enabled/default.conf
cp .template.env .env
make up
Wait until everything is done.
After everything is done, open up a web browser and go to http://127.0.0.1/ and the dashboard will open:
By Default, we can use the admin credential:
Set up different environment¶
To set up different environment, for example the Default credential, or the port of server, open deployment/.env. You can check the description below for each of variable.
COMPOSE_PROJECT_NAME=amlit
DB_PORT=5432
INITIAL_FIXTURES=True -> Put true for django initial data.
# Django env
DATABASE_NAME=django -> Default django database name
DATABASE_USERNAME=docker -> Default django database username
DATABASE_PASSWORD=docker -> Default django database password
DATABASE_HOST=db -> Default django database host
DATABASE_CIVITAS_NAME=civitas -> Default civitas database name
DATABASE_CIVITAS_HOST=db -> Default civitas database host
DATABASE_CIVITAS_PORT=5432 -> Default civitas database port
DATABASE_CIVITAS_USERNAME=docker -> Default civitas database username
DATABASE_CIVITAS_PASSWORD=docker -> Default civitas database password
# Email where altersAfter you change the desired variable and do `make up`. It will rerun the project with new environment.
should be sent. This will be used by let's encrypt and as the django admin email.
ADMIN_EMAIL=admin@example.com -> Default admin username
ADMIN_PASSWORD=admin -> Default admin password
# Email settings
EMAIL_HOST_USER=noreply@kartoza.com
EMAIL_HOST_PASSWORD=docker
EMAIL_HOST=smtp
EMAIL_HOST_DOMAIN=kartoza.com
HTTP_HOST=80
HTTPS_HOST=443
After you change the desired variable and do make up. It will rerun the project with the new environment.