host.and.docker.dual.mode.md

This project utilize flask-volt-dashboard which supports running application in docker or on the host. By furtherly following below steps, it can achieve:

• Both docker and host running methods share the same database file
• Source code change will take effect immediately for both running methods

1. create a virtual env and install all neccessary libs:

• virtualenv flask
• source flask/bin/activate
• pip3 install -r requirements.txt

2. upload openai api key and create log directory

Create directory configs in folder apps, put your openai API key string to file apps/configs/openai_api_key.txt

Create directory logs in folder apps

3. go to project folder, use following command to init and create database file:

In apps/__init__.py, set database uri:

app.config['SQLALCHEMY_DATABASE_URI'] = SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'db.sqlite3')

In apps/config.py, also set the database uri:

SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'db.sqlite3')

Then init the database:

flask db init
flask db migrate
flask db upgrade

This will create a file db.sqlite3 in folder apps

4. move the created database file outside the project folder, for example:

mv apps/db.sqlite3 /opt/sqlite/flask/

5. in dockerfile, since we already created the database, remove flask db related commands

6. in dockerfile, add following command:

WORKDIR /code

7. in docker-compose.yml, mount two directoies:

volumes:
    - .:/code
    - /opt/sqlite/flask/:/opt/sqlite/flask/

The first mounted path is to mount the project folder to container working directory /code. So any code change in source files will take effect with docker running; The second mounted path is to mount the database file directory to container

8. in apps/__init__.py where database path is defined, change url to the mounted database directory:

app.config['SQLALCHEMY_DATABASE_URI'] = SQLALCHEMY_DATABASE_URI = 'sqlite:////opt/sqlite/flask/db.sqlite3'