Skip to content

Latest commit

 

History

History
53 lines (42 loc) · 1.72 KB

README.md

File metadata and controls

53 lines (42 loc) · 1.72 KB
Raw

MechaDocker

Docker configuration for MechaBowser, Parakarry, and logviewer.

Quick Setup

  • Run the following shell commands:
git clone [email protected]:rNintendoSwitch/MechaDocker.git
cd MechaDocker
git submodule update --init --recursive --remote
git submodule foreach cp config.example.py config.py

# Setup database
python init_db_pass.py
docker volume create --name mechadocker-database -d local

docker-compose build
  • If you wish to be able to pull Mechabowser's private modules during runtime, see 'Pulling Private During Runtime'
  • Edit the config.py files in: Mechabowser/, Parakarry/, and (optionally) logviewer/
  • Start the service(s) with docker-compose up. See below for examples.

docker-compose up examples

# Run a limited set of services
docker-compose up parakarry logviewer

# Run with daemon 
docker-compose up -d 

# Run a service without database
docker-compose up --no-deps mechabowser

Pulling New Changes

  • Type the following shell commands to pull new changes (including submodules):
git pull
git submodule sync --recursive
git submodule update --recursive --remote

Pulling Private During Runtime

In order to pull Mechabowser's private modules, you must add first add your github username and a personal access token with the repo scope to the .env file, like so:

GITHUB_USER=yourusernamehere
GITHUB_TOKEN=yourtokenhere

Then, to pull private modules during runtime, run jsk sh ./update.sh instead of jsk sh git pull.