Kettlewright is a free, open-source application for managing characters and parties for the Cairn adventure game, currently in Beta. View the wiki, submit issues, or check out the source code on GitHub.
Create a file in ~/docker/kettlewright/ called .env and populate it with the following:
BASE_URL=http://127.0.0.1:8000 SECRET_KEY=[unique string] SQLALCHEMY_DATABASE_URI=sqlite:///db.sqlite MAIL_SERVER=[enter mail server details] MAIL_PORT=[Probably 587] MAIL_USE_TLS=[Probably 1] MAIL_USERNAME=[enter email address] MAIL_PASSWORD=[enter email password] REQUIRE_SIGNUP_CODE=[True_or_False] SIGNUP_CODE=[only needed if previous statement is True] USE_REDIS=[True_or_False] REDIS_URL=redis://redis-server:6379/0
Note: You will likely not need to mark USE_REDIS as 'True' unless you are planning to support hundreds of users. In that case please adjust the required worker count (typically 2 * CPU cores + 1). See "Using a redis server" below for more details.
Pull the Docker image:
docker pull yochaigal/kettlewright
Start Kettlewright
docker run -d --name kettlewright --env-file ~/docker/kettlewright/.env -v kettlewright_db:/app/instance -p 8000:8000 --restart always yochaigal/kettlewright
Open http://127.0.0.1:8000 to access Kettlewright.
By default the Kettlewright container should be labeled kettlewright, but it helps to know how to do the following anyway! To find the container id (typically the most recent container):
docker ps -aThen start or stop the container with:
docker start/stop [container/label]To see the logs, run:
docker logs -f [container/label]
Ctrl+C to exitTo remove old containers:
docker rm [container/label]To copy the database from the container volume:
docker cp [container/label]:/app/instance/db.sqlite .First, stop the container:
docker stop [container/label]
Then remove it:
docker rm [container/label]
Pull the latest image:
docker pull yochaigal/kettlewright
Start a new container using the latest image:
docker run -d --name kettlewright --env-file ~/docker/kettlewright/.env -v kettlewright_db:/app/instance -p 8000:8000 --restart always yochaigal/kettlewright
To update the Docker image automatically, install Watchtower:
docker pull containrrr/watchtower
Then, run the following command:
docker run -d --name watchtower --restart always -v /var/run/docker.sock:/var/run/docker.sock -e TZ=America/New_York containrrr/watchtower --cleanup --schedule "/5 *"
This will run Watchtower every 5 minutes and automatically at boot. It will update all available Docker images unless explicitly stated, as well as clean up old images.
If you plan to launch Kettlewright with multiple workers, you must use a redis server as a message queue.
Set the USE_REDIS value to True in your .env file.
Install redis:
docker pull redis
Run the redis container:
docker run --name redis-server --restart unless-stopped -p 6379:6379 -d redis redis-server --save 60 1 --loglevel warning
Launch Kettlewright:
docker run -d --name kettlewright --env-file ~/docker/kettlewright/.env -v kettlewright_db:/app/instance --link redis-server:redis-server -p 8000:8000 --restart always yochaigal/kettlewright
Clone the repository.
Copy .env.template to .env and insert the appropriate values.
Create the python environment and lock it:
pipenv shell pipenv lock
Install packages:
pipenv sync
Initialize database:
flask db upgrade exit
Run the app:
pipenv run dotenv run -- gunicorn -k eventlet -w 1 -b 0.0.0.0:8000 --timeout 120 'app:application'
It can be helpful to run the app with flask, as you can see changes immediately rather than after restarting the server.
Add USE_FLASK=True to the .env file
Create the python environment and lock it:
pipenv shell pipenv lock
Install packages:
pipenv sync
Initialize database:
flask db upgrade
Run the app:
flask run --port=8000 --debug