mirror of capsul cloud compute provider web application https://giit.cyberia.club/~forest/capsul-flask
Go to file
3wc 6fb9c651e8
continuous-integration/drone/push Build is passing Details
Revert accidental change to test DB settings
2021-08-16 03:08:52 +02:00
capsulflask Revert accidental change to test DB settings 2021-08-16 03:08:52 +02:00
docs Tidying; add .env.sample 2021-08-16 02:28:28 +02:00
.drone.yml Docker image, & local development docker-compose.yml (#2) 2021-07-22 01:18:10 +02:00
.env.sample Tidying; add .env.sample 2021-08-16 02:28:28 +02:00
.gitignore gitignore unittest output file 2021-08-16 02:07:36 +02:00
Dockerfile Docker image, & local development docker-compose.yml (#2) 2021-07-22 01:18:10 +02:00
LICENSE.md affero GPL license 2020-05-26 19:56:09 -05:00
Pipfile Basic testing using flask-testing 2021-08-16 02:07:34 +02:00
Pipfile.lock ensure that app is defined in app.py to fix login link logging issues. 2021-08-16 02:07:36 +02:00
README.md remove redundant get_vms() and add testing documentation from pull 2021-08-16 02:07:36 +02:00
app.py create TestHTTPClient that uses werkzueg test client, tests are passing 2021-08-16 02:07:36 +02:00
docker-compose.yml Fixes to compose file 2021-08-16 02:30:46 +02:00
letsencrypt-root-ca.crt simplify postgres connection parameters as a single string 2021-02-16 16:08:54 -06:00
setup.cfg affero GPL license 2020-05-26 19:56:09 -05:00
setup.py postgres automatic schema management roughly working 2020-05-09 19:13:20 -05:00

README.md

capsul-flask

screenshot of capsul.org home page

Python Flask web application implementing user accounts, payment, and virtual machine management for a smol "virtual machine (vm) as a service" aka "cloud compute" provider. Originally developed by Cyberia Computer Club for https://capsul.org

capsul-flask integrates with Stripe as a credit card processor, and BTCPay Server as a cryptocurrency payment processor.

capsul-flask invokes shell-scripts to create/manage libvirt/qemu vms, and it depends on dnsmasq to act as the DHCP server for the vms.

capsul-flask has a "hub and spoke" architecture. The "Hub" runs the web application and talks to the Postrges database, while the "Spoke"(s) are responsible for creating/managing virtual machines. In this way, capsul can be scaled to span more than one machine. One instance of the capsul-flask application can run in both hub mode and spoke mode at the same time, however there must only be one instance of the app running in "Hub" mode at any given time.

Quickstart (run capsul-flask on your computer in development mode)

# get an instance of postgres running locally on port 5432
# (you don't have to use docker, but we thought this might be the easiest for a how-to example)
docker run --rm -it -e POSTGRES_PASSWORD=dev -p 5432:5432 postgres &

# install dependencies 
sudo apt install pipenv python3-dev libpq-dev

# download and run
git clone https://giit.cyberia.club/~forest/capsul-flask
cd capsul-flask
pipenv install
pipenv run flask run

Interested in learning more? How about a trip to the the docs/ folder: