💊 capsul.org cloud compute service - python flask web application
Go to file
forest 456a634d1a Merge pull request 'rathouse migration' (#49) from rathouse into main
Reviewed-on: #49
2024-02-12 01:15:04 +00:00
capsulflask oops, fix bytes vs kb disk capacity 2024-02-11 19:12:04 -06:00
docs don't require ZFS for finding ram capacity 2023-12-03 15:39:19 -06:00
.gitignore starting setup for rathouse!!! 2023-12-03 12:55:31 -06:00
LICENSE.md affero GPL license 2020-05-26 19:56:09 -05:00
Pipfile oops 2023-12-03 14:10:18 -06:00
Pipfile.lock Changes for new psycopg :) 2023-12-03 16:17:13 -06:00
README.md Changes for new psycopg :) 2023-12-03 16:17:13 -06:00
app.py trying to fix logging 2020-05-15 23:19:01 -05:00
letsencrypt-root-ca.crt Update Letsencrypt root cert used for postgres TLS 2021-10-05 10:47:21 -05:00
setup.cfg psycopg2 -> psycopg 2023-12-03 14:04:54 -06: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 Postgres 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://git.cyberia.club/~forest/capsul-flask
cd capsul-flask
pipenv install
pipenv run flask run

# these are some notes I kept related to pipenv troubleshooting:
python3 -m pip uninstall pipenv
python3 -m pip uninstall virtualenv
python3 -m pip install pipenv
python3 -m pipenv install

...

apt get install python3.11 python3.11-distutils
pipenv --venv 
pipenv --rm

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