Using the official image - VITCMUN/munverse GitHub Wiki
The docker image is located at https://hub.docker.com/r/vitcmun/munverse
How to use this image
This image should be used with a docker-compose script.
- Official docker-compose.yaml to use in production.
- Official docker-compose.dev.yaml to use in development.
It uses a MongoDB database. Additionally, the development config consists of mongo-express, a UI for the mongo server.
In the same directory as the compose script, there should be a media
directory to hold profile pictures and logos for the event and council. The structure should be:
media/
├── profiles/
│ ├── user1.png
│ └── user2.png
├── event/
│ └── example_event_logo.png
├── council/
│ └── example_council_logo.png
For production, run using docker-compose up
and visit http://localhost
.
For development, run using docker-compose up -f docker-compose.yaml -f docker-compose.dev.yaml up
and visit http://localhost
for webapp and http://localhost:8081
for mongo-express.
Environment variables
This image uses several environment variables to configure the web app. They should be kept in the .env
file.
Variable | Use |
---|---|
NODE_ENV |
Possible values - 'test', 'development', 'production' |
MONGO_USERNAME |
Username for MongoDB server |
MONGO_PASSWORD |
Password for MongoDB server |
MONGO_DB |
Name of the database to use |
MONGO_EXPRESS_USERNAME |
Username for mongo-express |
MONGO_EXPRESS_PASSWORD |
Password for mongo-express |
MUNVERSE_EVENT_NAME |
Event name, eg. VITCMUN |
MUNVERSE_EVENT_URL |
relative URL for event logo |
MUNVERSE_COUNCIL_NAME |
Council name, eg. AIPPM |
MUNVERSE_COUNCIL_URL |
relative URL for council logo |
MUNVERSE_ADMIN_USERNAME |
Username for app's admin account |
MUNVERSE_ADMIN_PASSWORD |
Password for app's admin account |