Skip to content

Latest commit

 

History

History
118 lines (90 loc) · 3.65 KB

README.md

File metadata and controls

118 lines (90 loc) · 3.65 KB
Raw

CeSI (Centralized Supervisor Interface)

CeSI is a web interface for managing multiple supervisors from the same place.

Supervisor has its own web UI but managing multiple supervisor installations is hard with seperate UIs (If you are using the UI of course :). CeSI aims to solve this problem by creating a centralized web UI, based on the RPC interface of Supervisor.

Installation Methods

Manuel Instructions

Install Dependencies For Cesi Api

$ # On Ubuntu [18.04, 16.04, 14.04]
$ sudo apt install -y git python3 python3-pip python3-venv
$ # On Centos 7
$ sudo yum install -y git epel-release
$ sudo yum install -y python34 python34-pip python34-venv
$ # On Fedora 28
$ sudo dnf install -y git python3 python3-pip python3-venv

Install Cesi

$ export CESI_SETUP_PATH=~/cesi
$ mkdir ${CESI_SETUP_PATH}
$ cd ${CESI_SETUP_PATH}

$ # Download the project to ~/cesi directory
$ wget https://github.com/gamegos/cesi/releases/download/v2.7.1/cesi-extended.tar.gz -O cesi.tar.gz
$ tar -xvf cesi.tar.gz

$ # Create virtual environment and install requirement packages
$ python3 -m venv venv
$ source venv/bin/activate
(venv) $ pip3 install -r requirements.txt

$ # Run with command line
(venv) $ python3 ${CESI_SETUP_PATH}/cesi/run.py --config-file ${CESI_SETUP_PATH}/defaults/cesi.conf.toml

Install Cesi as a service

$ # If you want to change CESI_SETUP_PATH, you must change the configurations in the cesi.service file.
$ export CESI_SETUP_PATH=/opt/cesi
$ mkdir ${CESI_SETUP_PATH}
$ cd ${CESI_SETUP_PATH}

$ # Download the project to CESI_SETUP_PATH directory
$ wget https://github.com/gamegos/cesi/releases/download/v2.7.1/cesi-extended.tar.gz -O cesi.tar.gz
$ tar -xvf cesi.tar.gz

$ # Create virtual environment and install requirement packages
$ python3 -m venv venv
$ source venv/bin/activate
(venv) $ pip3 install -r requirements.txt
(venv) $ deactivate   # Deactivate virtual environment

$ # Build ui (First you must install dependencies for ui -> yarn) - Optional
$ cd ${CESI_SETUP_PATH}/cesi/ui
$ yarn install
$ yarn build

$ # Create cesi.conf.toml file and update cesi.conf.toml for your environment.
$ # Config file documentation can be found inside default file.
$ # (You must create cesi.conf in the etc directory for cesi.service)
$ sudo cp ${CESI_SETUP_PATH}/defaults/cesi.conf.toml /etc/cesi.conf.toml

$ # Run as a service
$ sudo cp ${CESI_SETUP_PATH}/defaults/cesi.service /etc/systemd/system/cesi.service
$ sudo systemctl daemon-reload
$ sudo systemctl start cesi

Running Cesi with uWSGI

You may want to run Cesi using uWSGI (or any other WSGI deamon). Configure your system in the similiar way to running as a service and use uwsgi to start app. Check defaults/cesi-uwsgi.ini for details.

While running with uWSGI Cesi config host and port are ignored.

First Login

Please change password after first login!

  • Username: admin
  • Password: admin

TODO

  • Fix user related api endpoints
  • Fix node log view
  • Refactor the usage of config
  • Rewrite dockerfile and publish image on docker hub under gamegos
  • Improve Docs
  • Do not use external adresses for javascript and css libraries
  • Use a logging lib
  • Better format for activity logs (tabbed date, level, component, message)
  • Auto refresh page
  • Option to select different templates
  • Upgrade flask
  • Add tests
  • CI integration