Docker image, & local development docker-compose.yml (#2 )

Adds: - a Docker image, which can be used in both development and production - a `docker-compose.yml` file for local development (could probably be adapted for production deployments) Testing: - `git checkout docker` - `docker-compose up` - pray 🙏 - go to http://localhost:5000 ## App architecture I added the ability to load secret config variables (`HUB_TOKEN`, `STRIPE_SECRET_KEY` etc) from files, to support [Docker Secrets](https://docs.docker.com/engine/swarm/secrets/) natively. The code should probably log an error if a specified `HUB_TOKEN_FILE` doesn't exist instead of failing silently.. ## Docker architecture This uses a multi-stage build to reduce the size of the final image -- having pipenv install to a predefined virtualenv, and then copying that over. The compose file doesn't include a definition for a cron runner service, and I haven't tested running one yet. Here be dragons! You can rebuild the image locally using `docker-compose build`, but this isn't required for changes to the app code, only if you edit the `Dockerfile`, or want to publish your image for use on a swarm server (in which case you will need to edit the image name to put in your own Docker hub credentials). Currently, the image is rebuilt (should set up auto-tagging..) and published with every push to this 3wordchant/capsul-flask fork. Reviewed-on: https://git.autonomic.zone/3wordchant/capsul-flask/pulls/2 Co-authored-by: 3wordchant <3wordchant@noreply.git.autonomic.zone> Co-committed-by: 3wordchant <3wordchant@noreply.git.autonomic.zone>
Add custom themes, THEME setting, basic "yolocolo" theme (#7 )
2021-07-22 01:18:10 +02:00 · 2021-07-22 01:15:39 +02:00 · 2021-07-21 16:47:46 -05:00 · 2021-07-21 16:46:50 -05:00 · 2021-07-21 23:46:37 +02:00 · 2021-07-21 16:45:53 -05:00
39 changed files with 1003 additions and 250 deletions
--- a/.drone.yml
+++ b/.drone.yml
@ -0,0 +1,13 @@
+---
+kind: pipeline
+name: publish docker image
+steps:
+  - name: build and publish
+    image: plugins/docker
+    settings:
+      username:
+        from_secret: docker_reg_username_3wc
+      password:
+        from_secret: docker_reg_passwd_3wc
+      repo: 3wordchant/capsul-flask
+      tags: ${DRONE_COMMIT_BRANCH}
--- a/.gitignore
+++ b/.gitignore
@ -1,5 +1,6 @@
 notes.txt
 .env
+.env.bak
 .vscode

 *.pyc
--- a/48
+++ b/48
@ -0,0 +1,48 @@
+FROM python:3.8-alpine as build
+
+RUN apk add --no-cache \
+    build-base \
+    gcc \
+    gettext \
+    git \
+    jpeg-dev \
+    libffi-dev \
+    libjpeg \
+    musl-dev \
+    postgresql-dev \
+    python3-dev \
+    zlib-dev
+
+RUN mkdir -p /app/{code,venv}
+WORKDIR /app/code
+COPY Pipfile Pipfile.lock /app/code/
+
+RUN python3 -m venv /app/venv
+RUN pip install pipenv setuptools
+ENV PATH="/app/venv/bin:$PATH" VIRTUAL_ENV="/app/venv"
+RUN pip install wheel cppy
+# Install dependencies into the virtual environment with Pipenv
+RUN pipenv install --deploy --verbose
+
+FROM python:3.8-alpine
+
+RUN apk add --no-cache \
+    cloud-utils \
+    libjpeg \
+    libpq \
+    libstdc++ \
+    libvirt-client \
+    openssh-client \
+    virt-install
+
+COPY . /app/code/
+WORKDIR /app/code
+
+COPY --from=build /app/venv /app/venv
+ENV PATH="/app/venv/bin:$PATH" VIRTUAL_ENV="/app/venv"
+
+CMD ["gunicorn", "--bind", "0.0.0.0:5000", "-k", "gevent", "--worker-connections", "1000", "app:app"]
+
+VOLUME /app/code
+
+EXPOSE 5000
--- a/README.md
+++ b/README.md
@ -1,227 +1,51 @@
-# capsulflask
+# capsul-flask

-Python Flask web application for capsul.org
+![screenshot of capsul.org home page](./docs/capsul.webp)

+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](https://cyberia.club) for https://capsul.org

-## how to run locally
+`capsul-flask` integrates with [Stripe](https://stripe.com/) as a credit card processor, and [BTCPay Server](https://github.com/btcpayserver/btcpayserver-docker) as a cryptocurrency payment processor.

-Ensure you have the pre-requisites for the psycopg2 Postgres database adapter package
+`capsul-flask` invokes [shell-scripts](./capsulflask/shell_scripts/) to create/manage [libvirt/qemu](https://www.libvirt.org/manpages/virsh.html) vms, and it depends on `dnsmasq` to act as the DHCP server for the vms.
+
+`capsul-flask` has a ["hub and spoke" architecture](./architecture.md). 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)

 ```
-sudo apt install python3-dev libpq-dev
-pg_config --version
-```
+# 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 &

-Ensure you have the wonderful `pipenv` python package management and virtual environment cli
+# install dependencies 
+sudo apt install pipenv python3-dev libpq-dev

-```
-sudo apt install pipenv
-```
-
-Create python virtual environment and install packages
-
-```
-# install deps
+# download and run
+git clone https://giit.cyberia.club/~forest/capsul-flask
+cd capsul-flask
 pipenv install
-```
-
-Run an instance of Postgres (I used docker for this, you can use whatever you want, point is its listening on localhost:5432)
-
-```
-docker run --rm -it -e POSTGRES_PASSWORD=dev -p 5432:5432 postgres
-```
-
-Run the app 
-
-```
 pipenv run flask run
 ```

-Run the app in gunicorn:
-
-```
-pipenv run gunicorn --bind 127.0.0.1:5000 -k gevent --worker-connections 1000 app:app
-```
-
-Once you log in for the first time, you will want to give yourself some free capsulbux so you can create fake capsuls for testing. 
-
-Note that by default when running locally, the `SPOKE_MODEL` is set to `mock`, meaning that it won't actually try to spawn vms.
-
-```
-pipenv run flask cli sql -c "INSERT INTO payments (email, dollars) VALUES ('<your email address here>', 20.00)"
-```
-
-## configuration:
-
-Create a `.env` file to set up the application configuration:
-
-```
-nano .env
-```
-
-You can enter any environment variables referenced in `__init__.py` to this file.
-
-For example you may enter your SMTP credentials like this:
-```
-MAIL_USERNAME=forest@nullhex.com
-MAIL_DEFAULT_SENDER=forest@nullhex.com
-MAIL_PASSWORD=**************
-```
-
-## how to view the logs on the database server (legion.cyberia.club)
-
-`sudo -u postgres pg_dump capsul-flask | gzip -9 > capsul-backup-2021-02-15.gz`
-
-----
-
-## cli 
-
-You can manually mess around with the database like this:
-
-```
-pipenv run flask cli sql -f test.sql
-```
-
-```
-pipenv run flask cli sql -c 'SELECT * FROM vms'
-```
-
-This one selects the vms table with the column name header:
-
-```
-pipenv run flask cli sql -c "SELECT string_agg(column_name::text, ', ') from information_schema.columns WHERE table_name='vms'; SELECT * from vms"
-```
-
-How to modify a payment manually, like if you get a chargeback or to fix customer payment issues:
-
-```
-$ pipenv run flask cli sql -c "SELECT id, created, email, dollars, invalidated from payments"
-1, 2020-05-05T00:00:00, forest.n.johnson@gmail.com, 20.00, FALSE
-
-$ pipenv run flask cli sql -c "UPDATE payments SET invalidated = True WHERE id = 1"
-1 rows affected.
-
-$ pipenv run flask cli sql -c "SELECT id, created, email, dollars, invalidated from payments"
-1, 2020-05-05T00:00:00, forest.n.johnson@gmail.com, 20.00, TRUE
-```
-
-
-How you would kick off the scheduled task:
-
-```
-pipenv run flask cli cron-task
-```
-
-----
-
-## postgres database schema management
-
-capsulflask has a concept of a schema version. When the application starts, it will query the database for a table named
-`schemaversion` that has one row and one column (`version`). If the `version` it finds is not equal to the `desiredSchemaVersion` variable set in `db.py`, it will run  migration scripts from the `schema_migrations` folder one by one until the `schemaversion` table shows the correct version.
-
-For example, the script named `02_up_xyz.sql` should contain code that migrates the database from schema version 1 to schema version 2. Likewise, the script `02_down_xyz.sql` should contain code that migrates from schema version 2 back to schema version 1.
-
-**IMPORTANT: if you need to make changes to the schema, make a NEW schema version. DO NOT EDIT the existing schema versions.**
-
-In general, for safety, schema version upgrades should not delete data. Schema version downgrades will simply throw an error and exit for now. 
-
-----
-
-## hub-and-spoke architecture
-
-![](readme/hub-and-spoke1.png)
-
-This diagram was created with https://app.diagrams.net/.
-To edit it, download the <a download href="readme/hub-and-spoke.xml">diagram file</a> and edit it with the https://app.diagrams.net/ web application, or you may run the application from [source](https://github.com/jgraph/drawio) if you wish.
-
-right now I have 2 types of operations, immediate mode and async.
-
-both types of operations do assignment synchronously. so if the system cant assign the operation to one or more hosts (spokes),
-or whatever the operation requires, then it will fail. 
-
-some operations tolerate partial failures, like, `capacity_avaliable` will succeed if at least one spoke succeeds.
-for immediate mode requests (like `list`, `capacity_avaliable`, `destroy`), assignment and completion of the operation are the same thing.
-
-for async ones, they can be assigned without knowing whether or not they succeeded (`create`).
-
-![](readme/hub-and-spoke2.png)
-
-This diagram was created with https://app.diagrams.net/.
-To edit it, download the <a download href="readme/hub-and-spoke.xml">diagram file</a> and edit it with the https://app.diagrams.net/ web application, or you may run the application from [source](https://github.com/jgraph/drawio) if you wish.
-
-if you issue a create, and it technically could go to any number of hosts, but only one host responds, it will succeed 
-but if you issue a create and somehow 2 hosts both think they own that task, it will fail and throw a big error. cuz it expects exactly 1 to own the create task
-
-currently its not set up to do any polling.  its not really like a queue at all. It's all immediate for the most part 
-
-----
-
-## how to setup btcpay server
-
-Generate a private key and the accompanying bitpay SIN for the btcpay API client. 
-
-  I used this code as an example: https://github.com/bitpay/bitpay-python/blob/master/bitpay/key_utils.py#L6
-
-```
-$ pipenv run python ./readme/generate_btcpay_keys.py
-```
-
-It should output something looking like this:
-
-```
-----BEGIN EC PRIVATE KEY-----
-EXAMPLEIArx/EXAMPLEKH23EXAMPLEsYXEXAMPLE5qdEXAMPLEcFHoAcEXAMPLEK
-oUQDQgAEnWs47PT8+ihhzyvXX6/yYMAWWODluRTR2Ix6ZY7Z+MV7v0W1maJzqeqq
-NQ+cpBvPDbyrDk9+Uf/sEaRCma094g==
-----END EC PRIVATE KEY-----
-
-
-EXAMPLEwzAEXAMPLEEXAMPLEURD7EXAMPLE
-```
-
-In order to register the key with the btcpay server, you have to first generate a pairing token using the btcpay server interface.
-This requires your btcpay server account to have access to the capsul store. Ask Cass about this.
-
-Navigate to `Manage store: Access Tokens` at: `https://btcpay.cyberia.club/stores/<store-id>/Tokens`
-
-![](readme/btcpay_sin_pairing.jpg)
-
-
-Finally, send an http request to the btcpay server to complete the pairing:
-
-```
-curl -H "Content-Type: application/json" https://btcpay.cyberia.club/tokens -d "{'id': 'EXAMPLEwzAEXAMPLEEXAMPLEURD7EXAMPLE', 'pairingCode': 'XXXXXXX'}"
-```
-
-It should respond with a token: 
-
-```
-{"data":[{"policies":[],"pairingCode":"XXXXXXX","pairingExpiration":1589473817597,"dateCreated":1589472917597,"facade":"merchant","token":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","label":"capsulflask"}]}
-```
-
-And you should see the token in the btcpay server UI:
-
-![](readme/paired.jpg)
-
-Now simply set your `BTCPAY_PRIVATE_KEY` variable in `.env`
-
-NOTE: make sure to use single quotes and replace the new lines with \n.
-
-```
-BTCPAY_PRIVATE_KEY='-----BEGIN EC PRIVATE KEY-----\nEXAMPLEIArx/EXAMPLEKH23EXAMPLEsYXEXAMPLE5qdEXAMPLEcFHoAcEXAMPLEK\noUQDQgAEnWs47PT8+ihhzyvXX6/yYMAWWODluRTR2Ix6ZY7Z+MV7v0W1maJzqeqq\nNQ+cpBvPDbyrDk9+Uf/sEaRCma094g==\n-----END EC PRIVATE KEY-----'
-```
-
-
-----
-
-## testing cryptocurrency payments
-
-I used litecoin to test cryptocurrency payments, because its the simplest & lowest fee cryptocurrency that BTCPay server supports. You can download the easy-to-use litecoin SPV wallet `electrum-ltc` from [github.com/pooler/electrum-ltc](https://github.com/pooler/electrum-ltc) or [electrum-ltc.org](https://electrum-ltc.org/), set up a wallet, and then either purchase some litecoin from an exchange, or ask Forest for some litecoin to use for testing.
-
-
-## sequence diagram explaining how BTC payment process works
-
-![btcpayment_process](readme/btcpayment_process.png)
-
-This diagram was created with https://app.diagrams.net/.
-To edit it, download the <a download href="readme/btcpayment_process.drawio">diagram file</a> and edit it with the https://app.diagrams.net/ web application, or you may run the application from [source](https://github.com/jgraph/drawio) if you wish.
+Interested in learning more? How about a trip to the the `docs/` folder:
+
+- [**Setting up capsul-flask locally**](./docs/local-set-up.md)
+  - [Manually](./docs/local-set-up.md#manually)
+  - [With docker-compose](./docs/local-set-up.md#docker_compose)
+- [**Configuring `capsul-flask`**](./docs/configuration.md)
+  - [Example configuration from capsul.org (production)](./docs/configuration.md#example)
+  - [Configuration-type-stuff that lives in the database ](./docs/configuration.md#config_that_lives_in_db)
+  - [Loading variables from files (docker secrets)](./docs/configuration.md#docker_secrets)
+- [**`capsul-flask`'s relationship to its Database Server**](./docs/database.md)
+  - [Database schema management (schema versions)](./docs/database.md#schema_management)
+  - [Running manual database queries](./docs/database.md#manual_queries)
+- [**`capsul-flask`'s hub-and-spoke architecture**](./docs/architecture.md)
+- [**Deploying capsul-flask on a server**](./docs/deployment.md)
+  - [Installing prerequisites for Spoke Mode](./docs/deployment.md#spoke_mode_prerequisites)
+  - [Deploying capsul-flask manually](./docs/deployment.md#deploy_manually)
+  - [Deploying capsul-flask with coop-cloud's docker-swarm configuration](./docs/deployment.md#coop_cloud_docker)
+  - [Deploying capsul-flask with coop-cloud's `abra` deployment tool](./docs/deployment.md#coop_cloud_abra)
+- [**Accepting cryptocurrency payments with BTCPay Server**](./docs/btcpay.md)
+  - [Setting up the BTCPAY_PRIVATE_KEY](./docs/btcpay.md#BTCPAY_PRIVATE_KEY)
+  - [Testing cryptocurrency payments](./docs/btcpay.md#testing)
+  - [Sequence diagram explaining how BTC payment process works (how we accept 0-confirmation transactions 😀)](./docs/btcpay.md#0_conf_diagram)
--- a/capsulflask/init.py
+++ b/capsulflask/init.py
@ -2,6 +2,7 @@ import logging
 from logging.config import dictConfig as logging_dict_config

 import atexit
+import jinja2
 import os
 import hashlib
 import requests
@ -26,12 +27,27 @@ class StdoutMockFlaskMail:
    def send(self, message: Message):
      current_app.logger.info(f"Email would have been sent if configured:\n\nto: {','.join(message.recipients)}\nsubject: {message.subject}\nbody:\n\n{message.body}\n\n")

+
 load_dotenv(find_dotenv())

+for var_name in [
+  "SPOKE_HOST_TOKEN", "HUB_TOKEN", "STRIPE_SECRET_KEY",
+  "BTCPAY_PRIVATE_KEY", "MAIL_PASSWORD"
+]:
+  var = os.environ.get(f"{var_name}_FILE")
+  if not var:
+    continue
+
+  if not os.path.isfile(var):
+    continue
+
+  with open(var) as secret_file:
+    os.environ[var_name] = secret_file.read().rstrip('\n')
+  del os.environ[f"{var_name}_FILE"]
+
 app = Flask(__name__)

 app.config.from_mapping(
-  
  BASE_URL=os.environ.get("BASE_URL", default="http://localhost:5000"),
  SECRET_KEY=os.environ.get("SECRET_KEY", default="dev"),
  HUB_MODE_ENABLED=os.environ.get("HUB_MODE_ENABLED", default="True").lower() in ['true', '1', 't', 'y', 'yes'],
@ -72,7 +88,9 @@ app.config.from_mapping(
  #STRIPE_WEBHOOK_SECRET=os.environ.get("STRIPE_WEBHOOK_SECRET", default="")

  BTCPAY_PRIVATE_KEY=os.environ.get("BTCPAY_PRIVATE_KEY", default="").replace("\\n", "\n"),
-  BTCPAY_URL=os.environ.get("BTCPAY_URL", default="https://btcpay.cyberia.club")
+  BTCPAY_URL=os.environ.get("BTCPAY_URL", default=""),
+
+  THEME=os.environ.get("THEME", default="")
 )

 app.config['HUB_URL'] = os.environ.get("HUB_URL", default=app.config['BASE_URL'])
@ -140,10 +158,13 @@ else:

 app.config['HTTP_CLIENT'] = MyHTTPClient(timeout_seconds=int(app.config['INTERNAL_HTTP_TIMEOUT_SECONDS']))

-try:
-  app.config['BTCPAY_CLIENT'] = btcpay.Client(api_uri=app.config['BTCPAY_URL'], pem=app.config['BTCPAY_PRIVATE_KEY'])
-except:
-  app.logger.warning("unable to create btcpay client. Capsul will work fine except cryptocurrency payments will not work. The error was: " + my_exec_info_message(sys.exc_info()))
+app.config['BTCPAY_ENABLED'] = False
+if app.config['BTCPAY_URL'] != "":
+  try:
+    app.config['BTCPAY_CLIENT'] = btcpay.Client(api_uri=app.config['BTCPAY_URL'], pem=app.config['BTCPAY_PRIVATE_KEY'])
+    app.config['BTCPAY_ENABLED'] = True
+  except:
+    app.logger.warning("unable to create btcpay client. Capsul will work fine except cryptocurrency payments will not work. The error was: " + my_exec_info_message(sys.exc_info()))

 # only start the scheduler and attempt to migrate the database if we are running the app.
 # otherwise we are running a CLI command.
@ -152,6 +173,14 @@ is_running_server = ('flask run' in command_line) or ('gunicorn' in command_line

 app.logger.info(f"is_running_server: {is_running_server}")

+if app.config['THEME'] != "":
+  my_loader = jinja2.ChoiceLoader([
+    jinja2.FileSystemLoader(
+      [os.path.join('capsulflask', 'theme', app.config['THEME']),
+       'capsulflask/templates']),
+  ])
+  app.jinja_loader = my_loader
+
 if app.config['HUB_MODE_ENABLED']:

  if app.config['HUB_MODEL'] == "capsul-flask":
@ -219,7 +248,6 @@ def override_url_for():
  return dict(url_for=url_for_with_cache_bust)


-
 def url_for_with_cache_bust(endpoint, **values):
  """
  Add a query parameter based on the hash of the file, this acts as a cache bust
@ -244,7 +272,3 @@ def url_for_with_cache_bust(endpoint, **values):
      values['q'] = current_app.config['STATIC_FILE_HASH_CACHE'][filename]

  return url_for(endpoint, **values)
-
-
-
-  
--- a/capsulflask/console.py
+++ b/capsulflask/console.py
@ -199,6 +199,14 @@ def create():
  capacity_avaliable = current_app.config["HUB_MODEL"].capacity_avaliable(512*1024*1024)
  errors = list()

+  affordable_vm_sizes = dict()
+  for key, vm_size in vm_sizes.items():
+    # if a user deposits $7.50 and then creates an f1-s vm which costs 7.50 a month, 
+    # then they have to delete the vm and re-create it, they will not be able to, they will have to pay again.
+    # so for UX it makes a lot of sense to give a small margin of 25 cents for usability sake
+    if vm_size["dollars_per_month"] <= account_balance+0.25:
+      affordable_vm_sizes[key] = vm_size
+
  if request.method == "POST":
    if "csrf-token" not in request.form or request.form['csrf-token'] != session['csrf-token']:
      return abort(418, f"u want tea")
@ -209,6 +217,8 @@ def create():
      errors.append("Size is required")
    elif size not in vm_sizes:
      errors.append(f"Invalid size {size}")
+    elif size not in affordable_vm_sizes:
+      errors.append(f"Your account must have enough credit to run an {size} for 1 month before you will be allowed to create it")

    if not os:
      errors.append("OS is required")
@ -260,13 +270,6 @@ def create():
      
      return redirect(f"{url_for('console.index')}?created={id}")
  
-  affordable_vm_sizes = dict()
-  for key, vm_size in vm_sizes.items():
-    # if a user deposits $7.50 and then creates an f1-s vm which costs 7.50 a month, 
-    # then they have to delete the vm and re-create it, they will not be able to, they will have to pay again.
-    # so for UX it makes a lot of sense to give a small margin of 25 cents for usability sake
-    if vm_size["dollars_per_month"] <= account_balance+0.25:
-      affordable_vm_sizes[key] = vm_size

  for error in errors:
    flash(error)
@ -423,6 +426,7 @@ def account_balance():
    has_vms=len(vms_billed)>0, 
    vms_billed=vms_billed,
    warning_text=warning_text,
+    btcpay_enabled=current_app.config["BTCPAY_ENABLED"],
    payments=list(map(
      lambda x: dict(
        dollars=x["dollars"], 
--- a/capsulflask/hub_model.py
+++ b/capsulflask/hub_model.py
@ -17,6 +17,10 @@ from capsulflask.http_client import HTTPResult
 from capsulflask.shared import VirtualizationInterface, VirtualMachine, OnlineHost, validate_capsul_id, my_exec_info_message

 class MockHub(VirtualizationInterface):
+  def __init__(self):
+    self.default_network = "public1"
+    self.default_ipv4 = "1.1.1.1"
+
  def capacity_avaliable(self, additional_ram_bytes):
    return True

@ -29,9 +33,9 @@ class MockHub(VirtualizationInterface):
        {"key_type":"RSA", "content":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCvotgzgEP65JUQ8S8OoNKy1uEEPEAcFetSp7QpONe6hj4wPgyFNgVtdoWdNcU19dX3hpdse0G8OlaMUTnNVuRlbIZXuifXQ2jTtCFUA2mmJ5bF+XjGm3TXKMNGh9PN+wEPUeWd14vZL+QPUMev5LmA8cawPiU5+vVMLid93HRBj118aCJFQxLgrdP48VPfKHFRfCR6TIjg1ii3dH4acdJAvlmJ3GFB6ICT42EmBqskz2MPe0rIFxH8YohCBbAbrbWYcptHt4e48h4UdpZdYOhEdv89GrT8BF2C5cbQ5i9qVpI57bXKrj8hPZU5of48UHLSpXG8mbH0YDiOQOfKX/Mt", "sha256":"ghee6KzRnBJhND2kEUZSaouk7CD6o6z2aAc8GPkV+GQ"},
        {"key_type":"ECDSA", "content":"ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBLLgOoATz9R4aS2kk7vWoxX+lshK63t9+5BIHdzZeFE1o+shlcf0Wji8cN/L1+m3bi0uSETZDOAWMP3rHLJj9Hk=", "sha256":"aCYG1aD8cv/TjzJL0bi9jdabMGksdkfa7R8dCGm1yYs"}
      ]""")
-      return VirtualMachine(id, current_app.config["SPOKE_HOST_ID"], ipv4="1.1.1.1", ssh_host_keys=ssh_host_keys)
+      return VirtualMachine(id, current_app.config["SPOKE_HOST_ID"], ipv4=self.default_ipv4, ssh_host_keys=ssh_host_keys)

-    return VirtualMachine(id, current_app.config["SPOKE_HOST_ID"], ipv4="1.1.1.1")
+    return VirtualMachine(id, current_app.config["SPOKE_HOST_ID"], ipv4=self.default_ipv4)

  def list_ids(self) -> list:
    return get_model().all_non_deleted_vm_ids()
@ -40,6 +44,16 @@ class MockHub(VirtualizationInterface):
    validate_capsul_id(id)
    current_app.logger.info(f"mock create: {id} for {email}")
    sleep(1)
+    get_model().create_vm(
+      email=email, 
+      id=id, 
+      size=size, 
+      os=os,
+      host=current_app.config["SPOKE_HOST_ID"],
+      network_name=self.default_network,
+      public_ipv4=self.default_ipv4,
+      ssh_authorized_keys=list(map(lambda x: x["name"], ssh_authorized_keys)),
+    )

  def destroy(self, email: str, id: str):
    current_app.logger.info(f"mock destroy: {id} for {email}")
@ -49,7 +63,6 @@ class MockHub(VirtualizationInterface):


 class CapsulFlaskHub(VirtualizationInterface):
-
  def synchronous_operation(self, hosts: List[OnlineHost], email: str, payload: str) -> List[HTTPResult]:
    return self.generic_operation(hosts, email, payload, True)[1]
  
@ -262,4 +275,3 @@ class CapsulFlaskHub(VirtualizationInterface):

    if not result_status == "success":
      raise ValueError(f"""failed to {command} vm "{id}" on host "{host.id}" for {email}: {result_json_string}""")
-
--- a/capsulflask/landing.py
+++ b/capsulflask/landing.py
@ -12,9 +12,11 @@ def index():

@bp.route("/pricing")
 def pricing():
+  vm_sizes = get_model().vm_sizes_dict()
  operating_systems = get_model().operating_systems_dict()
  return render_template(
    "pricing.html", 
+    vm_sizes=vm_sizes,
    operating_systems=operating_systems
  )

--- a/capsulflask/payment.py
+++ b/capsulflask/payment.py
@ -48,6 +48,10 @@ def validate_dollars():
 def btcpay_payment():
  errors = list()

+  if not current_app.config['BTCPAY_ENABLED']:
+    flash("BTCPay is not enabled on this server")
+    return redirect(url_for("console.account_balance"))
+
  if request.method == "POST":
    result = validate_dollars()
    errors = result[0]
--- a/capsulflask/static/favicon.yolocolo.ico
+++ b/capsulflask/static/favicon.yolocolo.ico
--- a/capsulflask/static/icon.yolocolo.png
+++ b/capsulflask/static/icon.yolocolo.png
--- a/capsulflask/static/style.css
+++ b/capsulflask/static/style.css
@ -241,7 +241,6 @@ thead {
  background: #bdc7b812;
 }
 td, th {
-
  padding: 0.1em 1em;
 }
 table.small td, table.small th {
--- a/capsulflask/static/style.yolocolo.css
+++ b/capsulflask/static/style.yolocolo.css
@ -0,0 +1,35 @@
+html {
+  color: #241e1e !important;
+  background-color: #bdc7b8 !important;
+}
+
+a {
+  color:#00517a !important;
+  text-shadow: 1px 1px 0px #eee !important;
+}
+
+a:hover, a:active, a:visited {
+  color: #323417 !important;
+} 
+
+.nav-links  a {
+  text-shadow: 2px 2px 0px #eee !important;
+}
+
+h1, h2, h3, h4, h5 {
+	text-shadow: 2px 2px 0px #eee;
+}
+
+main {
+  border: 1px dashed #241e1e !important;
+}
+
+
+input, select, textarea {
+  color: #241e1e !important;
+}
+
+th {
+  border-right: 1px solid #eee !important;
+  text-align: left !important;
+}
--- a/capsulflask/templates/account-balance.html
+++ b/capsulflask/templates/account-balance.html
@ -46,7 +46,9 @@
            <a href="/payment/stripe">Add funds with Credit/Debit (stripe)</a>
            <ul><li>notice: stripe will load nonfree javascript </li></ul>
          </li>
+          {% if btcpay_enabled %}
          <li><a href="/payment/btcpay">Add funds with Bitcoin/Litecoin/Monero (btcpay)</a></li>
+          {% endif %}
    
          <li>Cash: email <a href="mailto:treasurer@cyberia.club">treasurer@cyberia.club</a></li>
        </ul>
--- a/capsulflask/templates/faq.html
+++ b/capsulflask/templates/faq.html
@ -23,6 +23,7 @@
     How do I log in?
     <p>ssh to the ip provided to you using the cyberian user.</p>
     <pre class='code'>$ ssh cyberian@1.2.3.4</pre>
+     <p>For more information, see <a href="/about-ssh">Understanding the Secure Shell Protocol (SSH)</a>.</p>
   </li>
   <li>
     How do I change to the root user?
--- a/capsulflask/templates/pricing.html
+++ b/capsulflask/templates/pricing.html
@ -6,22 +6,38 @@
  <div class="row third-margin">
    <h1>CAPSUL TYPES & PRICING</h1>
  </div>
+  <div class="row half-margin">
+    <table>
+      <thead>
+        <tr>
+          <th>type</th>
+          <th>monthly*</th>
+          <th>cpus</th>
+          <th>mem</th>
+          <th>ssd</th>
+          <th>net</th>
+        </tr>
+      </thead>
+      <tbody>
+      {% for vm_size_key, vm_size in vm_sizes.items() %}
+        <tr>
+          <td>{{ vm_size_key }}</td>
+          <td>${{ vm_size['dollars_per_month'] }}</td>
+          <td>{{ vm_size['vcpus'] }}</td>
+          <td>{{ vm_size['memory_mb'] }}</td>
+          <td>25G</td>
+          <td>{{ vm_size['bandwidth_gb_per_month'] }}</td>
+        </tr>
+      {% endfor %}
+      </tbody>
+    </table>
+  </div>
  <div class="row half-margin">
    <pre>
-    type     monthly*  cpus  mem     ssd   net*
-    -----    -------   ----  ---     ---   ---
-    f1-xs    $5.00     1     512M    25G   .5TB
-    f1-s     $7.50     1     1024M   25G   1TB
-    f1-m     $12.50    1     2048M   25G   2TB
-    f1-l     $20.00    2     3072M   25G   3TB
-    f1-x     $27.50    3     4096M   25G   4TB
-    f1-xx    $50.00    4     8192M   25G   5TB
-
    * net is calculated as a per-month average
    * vms are billed for a minimum of 24 hours upon creation
    * all VMs come standard with one public IPv4 address
    
-    
    SUPPORTED OPERATING SYSTEMS:


--- a/capsulflask/theme/yolocolo/account-balance.html
+++ b/capsulflask/theme/yolocolo/account-balance.html
@ -0,0 +1,94 @@
+{% extends 'base.html' %}
+
+{% block title %}Account Balance{% endblock %}
+
+{% block content %}
+<div class="row third-margin">
+  <h1>Account Balance: ${{ account_balance }}</h1>
+</div>
+<div class="half-margin">
+ 
+  {% if has_vms and has_payments and warning_text != "" %}
+  <div class="row">
+    <pre class="wrap">{{ warning_text }}</pre>
+  </div>
+  {% endif %}
+  <div class="row">
+    {% if has_payments %}
+    <div>
+      <div class="row third-margin">
+        <h1>Payments</h1>
+      </div>
+    
+      <table>
+        <thead>
+          <tr>
+            <th>amount</th>
+            <th>date</th>
+          </tr>
+        </thead>
+        <tbody>
+          {% for payment in payments %}
+            <tr>
+              <td class="{{ payment['class_name'] }}">${{ payment["dollars"] }}</td>
+              <td class="{{ payment['class_name'] }}">{{ payment["created"] }}</td>
+            </tr>
+          {% endfor %}
+        </tbody>
+      </table>
+    </div>
+    {% endif %}
+    <ul>
+      <li>
+        <h1>PAYMENT OPTIONS</h1>
+        <ul>
+          <li>
+            <a href="/payment/stripe">Add funds with Credit/Debit (stripe)</a>
+            <ul><li>notice: stripe will load nonfree javascript </li></ul>
+          </li>
+          {% if btcpay_enabled %}
+          <li><a href="/payment/btcpay">Add funds with Bitcoin/Litecoin/Monero (btcpay)</a></li>
+          {% endif %}
+        </ul>
+      </li>
+    </ul>
+
+  </div>
+
+
+  {% if has_vms %}
+  <div class="row third-margin">
+    <h1>Capsuls Billed</h1>
+  </div>
+  <div class="row">
+    <table class="small">
+      <thead>
+        <tr>
+          <th>id</th>
+          <th>created</th>
+          <th>deleted</th>
+          <th>$/month</th>
+          <th>months</th>
+          <th>$ billed</th>
+        </tr>
+      </thead>
+      <tbody>
+        {% for vm in vms_billed %}
+          <tr>
+            <td>{{ vm["id"] }}</td>
+            <td>{{ vm["created"] }}</td>
+            <td>{{ vm["deleted"] }}</td>
+            <td>${{ vm["dollars_per_month"] }}</td>
+            <td>{{ vm["months"] }}</td>
+            <td>${{ vm["dollars"] }}</td>
+          </tr>
+        {% endfor %}
+      </tbody>
+    </table>
+  </div>
+  
+  {% endif %}
+</div>
+{% endblock %}
+
+{% block pagesource %}/templates/create-capsul.html{% endblock %}
--- a/capsulflask/theme/yolocolo/base.html
+++ b/capsulflask/theme/yolocolo/base.html
@ -0,0 +1,60 @@
+<html lang="en">
+<head>
+  <!-- Namecoin Address: N2aVL6pHtBp7EtNGb3jpsL2L2NyjBNbiB1 -->
+  <link href="{{ url_for('static', filename='favicon.yolocolo.ico') }}" rel="icon">
+  <title>{% block title %}{% endblock %}{% if self.title() %} - {% endif %}Capsul</title>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width,initial-scale=1.0">
+  <meta name="Description" content="Cyberia Capsul">
+  {% block head %}{% endblock %}
+  <link rel="stylesheet" href="{{ url_for('static', filename='style.css') }}">
+  <link rel="stylesheet" href="{{ url_for('static', filename='style.yolocolo.css') }}">
+</head>
+<body>
+<nav>
+  <div class="row justify-space-between half-margin">
+    <div>
+      🦉 <a href="/"><b>YOLOCOLO</b></a>
+    </div>
+    <div>
+      &nbsp;
+      {% if session["account"] %} 
+        { {{ session["account"] }} <a href="{{ url_for('auth.logout') }}">Log Out</a> } 
+      {% else %} 
+        <a href="{{ url_for('auth.login') }}">Login</a>
+      {% endif %}
+    </div>
+  </div>
+  <div class="row justify-center half-margin wrap nav-links">
+    <a href="/pricing">Pricing</a>
+    <a href="/faq">FAQ</a>
+
+    {% if session["account"] %} 
+      <a href="/console">Capsuls</a>
+      <a href="/console/ssh">SSH Public Keys</a>
+      <a href="/console/account-balance">Account Balance</a>
+    {% endif %}
+
+    <a href="/support">Support</a>
+  </div>
+</nav>
+{% for message in get_flashed_messages() %}
+  <div class="flash">{{ message }}</div>
+{% endfor %}
+{% block custom_flash %}{% endblock %}
+<main>
+  {% block content %}{% endblock %}
+</main>
+{% block subcontent %}{% endblock %}
+<footer>
+  This server runs <a
+    href="https://giit.cyberia.club/~forest/capsul-flask">capsul-flask</a> by
+  Cyberia Computer Club, available under the <a
+    href="https://creativecommons.org/licenses/by-sa/4.0/">Attribution-ShareAlike
+    4.0 International</a> licence.<br/><br/>
+  <a href="https://git.autonomic.zone/3wordchant/capsul-flask/src/branch/yolocolo/capsulflask{% block pagesource %}{% endblock %}">View page source</a>
+</footer>
+</body>
+</html>
+
+
--- a/capsulflask/theme/yolocolo/capsuls.html
+++ b/capsulflask/theme/yolocolo/capsuls.html
@ -0,0 +1,68 @@
+{% extends 'base.html' %}
+
+{% block title %}Capsuls{% endblock %}
+
+{% block custom_flash %}
+{% if created  %} 
+  <div class="flash green">{{ created }} successfully created!</div>
+{% endif %}
+{% endblock %}
+
+{% block content %}
+<div class="row third-margin">
+  <h1>Capsuls</h1>
+</div>
+<div class="third-margin">
+  {% if has_vms %} 
+  <div class="row third-margin justify-end">
+    <a href="/console/create">Create Capsul</a>
+  </div>
+  <div class="row">
+    <table>
+      <thead>
+        <tr>
+          <th class="heart-icon">❦</th>
+          <th>id</th>
+          <th>size</th>
+          <th>cpu</th>
+          <th>mem</th>
+          <th>ipv4</th>
+          <th>os</th>
+          <th>created</th>
+        </tr>
+      </thead>
+      <tbody>
+        {% for vm in vms %}
+          <tr>
+            {% if vm['state'] == 'starting' or vm['state'] == 'stopping'  %}
+              <td class="capsul-status waiting-pulse">•</td>
+            {% elif vm['state'] == 'crashed' or vm['state'] == 'blocked' or vm['state'] == 'stopped'  %}
+              <td class="capsul-status red">•</td>
+            {% elif vm['state'] == 'unknown' %}
+              <td class="capsul-status-questionmark">?</td>
+            {% else  %}
+              <td class="capsul-status green">•</td>
+            {% endif  %}
+            
+            <td><a class="no-shadow" href="/console/{{ vm['id'] }}">{{ vm["id"] }}</a></td>
+            <td>{{ vm["size"] }}</td>
+            <td class="metrics"><img src="/metrics/cpu/{{ vm['id'] }}/5m/s"/></td>
+            <td class="metrics"><img src="/metrics/memory/{{ vm['id'] }}/5m/s"/></td>
+            <td class="{{ vm['ipv4_status'] }}">{{ vm["ipv4"] }}</td>
+            <td>{{ vm["os"] }}</td>
+            <td>{{ vm["created"] }}</td>
+          </tr>
+        {% endfor %}
+      </tbody>
+    </table>
+  </div>
+  
+  {% else %} 
+  <div class="row">
+    <p>You don't have any Capsuls running. <a href="/console/create">Create one</a> today!</p>
+  </div>
+  {% endif %}
+</div>
+{% endblock %}
+
+{% block pagesource %}/templates/capsuls.html{% endblock %}
--- a/capsulflask/theme/yolocolo/faq.html
+++ b/capsulflask/theme/yolocolo/faq.html
@ -0,0 +1,46 @@
+{% extends 'base.html' %}
+
+{% block title %}FAQ{% endblock %}
+
+{% block content %}
+  <div class="row full-margin"><h1>Frequently Asked Questions</h1></div>
+{% endblock %}
+
+{% block subcontent %}
+<p>
+ <ul>
+   <li>
+     What is this?
+     <p>
+      This is a <strong>technical demo</strong> of <a
+       href="https://giit.cyberia.club/~forest/capsul-flask">Capsul</a>, for the
+      as-yet-untitled <a href="https://coops.tech">Cotech</a> server hosting
+      initiative, which you can <a
+      href="https://community.coops.tech/t/call-for-input-v2-co-op-vps-survey/2802/9">read
+     about on the Cotech forum</a>.
+     </p>
+   </li>
+   <li>
+     What do you mean, "technical demo"?
+     <p>No backups</p>
+     <p>No service level agreement</p>
+     <p>"Best effort" support</p>
+   </li>
+   <li>
+     Where can I get this, but, more reliable?
+     <p>Cyberia, the authors of this platform, run the canonical instance, <a
+      href="https://capsul.org">Capsul.org</a>, on hardware they own. Please
+     send them your money! (cash, crypto, or card accepted).</p>
+   </li>
+   <li>
+     How do I use this system?
+     <p>Please see <a href="https://capsul.org/faq">the official Capsul FAQ
+       page</a>.</p>
+   </li>
+ </ul>
+</p>
+
+{% endblock %}
+
+{% block pagesource %}/templates/faq.html{% endblock %}
+
--- a/capsulflask/theme/yolocolo/index.html
+++ b/capsulflask/theme/yolocolo/index.html
@ -0,0 +1,28 @@
+{% extends 'base.html' %}
+
+{% block content %}
+  <h1>
+  <pre>
+             _                 _
+ _   _  ___ | | ___   ___ ___ | | ___
+| | | |/ _ \| |/ _ \ / __/ _ \| |/ _ \
+| |_| | (_) | | (_) | (_| (_) | | (_) |
+ \__, |\___/|_|\___/ \___\___/|_|\___/
+ |___/
+
+  </pre>
+  <span>Co-operative hosting using <a href="https://cyberia.club">Cyberia</a>'s Capsul</span>
+{% endblock %}
+
+{% block subcontent %}
+<p>
+ <ul>
+   <li>Sign up for an account!</li>
+   <li>Add some funds!</li>
+   <li>Create a VPS!</li>
+   <li>Give your feedback!</li>
+ </ul>           
+</p>
+{% endblock %}
+
+{% block pagesource %}/templates/index.html{% endblock %}
--- a/capsulflask/theme/yolocolo/pricing.html
+++ b/capsulflask/theme/yolocolo/pricing.html
@ -0,0 +1,23 @@
+{% extends 'base.html' %}
+
+{% block title %}Pricing{% endblock %}
+
+{% block content %}
+  <div class="row third-margin">
+    <h1>CAPSUL TYPES & PRICING</h1>
+  </div>
+  <div class="row half-margin">
+    <p>
+      Rates for this service aren't set yet. You can see Cyberia's Capsul pricing
+      on <a href="https://capsul.org/pricing">their website</a>.
+    </p>
+  </div>
+  <div>
+    <pre>
+      SUPPORTED OPERATING SYSTEMS:
+
+      {% for os_id, os in operating_systems.items() %}   - {{ os.description }} 
+      {% endfor %}
+    </pre>
+  </div>
+{% endblock %}
--- a/capsulflask/theme/yolocolo/support.html
+++ b/capsulflask/theme/yolocolo/support.html
@ -0,0 +1,21 @@
+{% extends 'base.html' %}
+
+{% block title %}Support{% endblock %}
+
+{% block content %}
+  <div class="row half-margin">
+    <h1>SUPPORT</h1>
+  </div>
+  <div class="row half-margin">
+    <a href="mailto:yolocolo@doesthisthing.work?subject=Please%20help!">yolocolo@doesthisthing.work</a> 
+  </div>
+{% endblock %}
+
+{% block subcontent %}
+<p>
+  You can also find us on Matrix: <a
+    href="https://matrix.to/#/#untitled-hosting.public:autonomic.zone">#untitled-hosting.public:autonomic.zone</a>.
+</p>
+{% endblock %}
+
+{% block pagesource %}/templates/support.html{% endblock %}
--- a/docker-compose.yml
+++ b/docker-compose.yml
@ -0,0 +1,36 @@
+---
+version: "3.8"
+
+services:
+  app:
+    image: 3wordchant/capsul-flask:latest
+    build: .
+    volumes:
+      - "./:/app/code"
+      - "../tank:/tank"
+      # - "/var/run/libvirt/libvirt-sock:/var/run/libvirt/libvirt-sock"
+    depends_on:
+      - db
+    ports:
+      - "5000:5000"
+    environment:
+      - "POSTGRES_CONNECTION_PARAMETERS=host=db port=5432 user=capsul password=capsul dbname=capsul"
+      - SPOKE_MODEL=shell-scripts
+        #- FLASK_DEBUG=1
+      - BASE_URL=http://localhost:5000
+      - ADMIN_PANEL_ALLOW_EMAIL_ADDRESSES=3wc.capsul@doesthisthing.work
+      - VIRSH_DEFAULT_CONNECT_URI=qemu:///system
+    # The image uses gunicorn by default, let's override it with Flask's
+    # built-in development server
+    command: ["flask", "run", "-h", "0.0.0.0", "-p", "5000"]
+  db:
+    image: "postgres:9.6.5-alpine"
+    volumes:
+      - "postgres:/var/lib/postgresql/data"
+    environment:
+      POSTGRES_USER: capsul
+      POSTGRES_PASSWORD: capsul
+      POSTGRES_DB: capsul
+
+volumes:
+  postgres:
--- a/docs/architecture.md
+++ b/docs/architecture.md
@ -0,0 +1,30 @@
+# 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. One instance of the capsul-flask application can run in hub mode and spoke mode at the same time. 
+
+The Hub and the Spoke must be configured to communicate securely with each-other over HTTPS. They both have to be able to dial each-other directly.  The URLs / auth tokens they use are configured both in the config file (`HUB_URL`, `SPOKE_HOST_ID`, `SPOKE_HOST_TOKEN` and `HUB_TOKEN`) and in the database (the `id`, `https_url`, and `token` columns in the `hosts` table).
+
+![](images/hub-and-spoke1.png)
+
+This diagram was created with https://app.diagrams.net/.
+To edit it, download the <a download href="readme/hub-and-spoke.xml">diagram file</a> and edit it with the https://app.diagrams.net/ web application, or you may run the application from [source](https://github.com/jgraph/drawio) if you wish.
+
+right now I have 2 types of operations, immediate mode and async.
+
+both types of operations do assignment synchronously. so if the system cant assign the operation to one or more hosts (spokes),
+or whatever the operation requires, then it will fail. 
+
+some operations tolerate partial failures, like, `capacity_avaliable` will succeed if at least one spoke succeeds.
+for immediate mode requests (like `list`, `capacity_avaliable`, `destroy`), assignment and completion of the operation are the same thing.
+
+for async ones, they can be assigned without knowing whether or not they succeeded (`create`).
+
+![](images/hub-and-spoke2.png)
+
+This diagram was created with https://app.diagrams.net/.
+To edit it, download the <a download href="readme/hub-and-spoke.xml">diagram file</a> and edit it with the https://app.diagrams.net/ web application, or you may run the application from [source](https://github.com/jgraph/drawio) if you wish.
+
+if you issue a create, and it technically could go to any number of hosts, but only one host responds, it will succeed 
+but if you issue a create and somehow 2 hosts both think they own that task, it will fail and throw a big error. cuz it expects exactly 1 to own the create task
+
+currently its not set up to do any polling.  its not really like a queue at all. It's all immediate for the most part 
--- a/docs/btcpay.md
+++ b/docs/btcpay.md
@ -0,0 +1,68 @@
+## <a name="BTCPAY_PRIVATE_KEY"></a>Setting up the BTCPAY_PRIVATE_KEY 
+
+Generate a private key and the accompanying bitpay SIN for the btcpay API client. 
+
+I used this code as an example: https://github.com/bitpay/bitpay-python/blob/master/bitpay/key_utils.py#L6
+
+```
+$ pipenv run python ./readme/generate_btcpay_keys.py
+```
+
+It should output something looking like this:
+
+```
+-----BEGIN EC PRIVATE KEY-----
+EXAMPLEIArx/EXAMPLEKH23EXAMPLEsYXEXAMPLE5qdEXAMPLEcFHoAcEXAMPLEK
+oUQDQgAEnWs47PT8+ihhzyvXX6/yYMAWWODluRTR2Ix6ZY7Z+MV7v0W1maJzqeqq
+NQ+cpBvPDbyrDk9+Uf/sEaRCma094g==
+-----END EC PRIVATE KEY-----
+
+
+EXAMPLEwzAEXAMPLEEXAMPLEURD7EXAMPLE
+```
+
+In order to register the key with the btcpay server, you have to first generate a pairing token using the btcpay server interface.
+This requires your btcpay server account to have access to the capsul store. Ask Cass about this.
+
+Navigate to `Manage store: Access Tokens` at: `https://btcpay.cyberia.club/stores/<store-id>/Tokens`
+
+![](images/btcpay_sin_pairing.jpg)
+
+
+Finally, send an http request to the btcpay server to complete the pairing:
+
+```
+curl -H "Content-Type: application/json" https://btcpay.cyberia.club/tokens -d "{'id': 'EXAMPLEwzAEXAMPLEEXAMPLEURD7EXAMPLE', 'pairingCode': 'XXXXXXX'}"
+```
+
+It should respond with a token: 
+
+```
+{"data":[{"policies":[],"pairingCode":"XXXXXXX","pairingExpiration":1589473817597,"dateCreated":1589472917597,"facade":"merchant","token":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","label":"capsulflask"}]}
+```
+
+And you should see the token in the btcpay server UI:
+
+![](images/paired.jpg)
+
+Now simply set your `BTCPAY_PRIVATE_KEY` variable in `.env`
+
+NOTE: make sure to use single quotes and replace the new lines with \n.
+
+```
+BTCPAY_PRIVATE_KEY='-----BEGIN EC PRIVATE KEY-----\nEXAMPLEIArx/EXAMPLEKH23EXAMPLEsYXEXAMPLE5qdEXAMPLEcFHoAcEXAMPLEK\noUQDQgAEnWs47PT8+ihhzyvXX6/yYMAWWODluRTR2Ix6ZY7Z+MV7v0W1maJzqeqq\nNQ+cpBvPDbyrDk9+Uf/sEaRCma094g==\n-----END EC PRIVATE KEY-----'
+```
+
+-----
+
+## <a name="testing"></a>testing cryptocurrency payments
+
+I used litecoin to test cryptocurrency payments, because its the simplest & lowest fee cryptocurrency that BTCPay server supports. You can download the easy-to-use litecoin SPV wallet `electrum-ltc` from [github.com/pooler/electrum-ltc](https://github.com/pooler/electrum-ltc) or [electrum-ltc.org](https://electrum-ltc.org/), set up a wallet, and then either purchase some litecoin from an exchange, or [ask Forest for some litecoin](https://sequentialread.com/capsul-rollin-onwards-with-a-web-application/#sqr-comment-container) to use for testing.
+
+
+## <a name="0_conf_diagram"></a>sequence diagram explaining how BTC payment process works (how we accept 0-confirmation transactions 😀)
+
+![btcpayment_process](images/btcpayment_process.png)
+
+This diagram was created with https://app.diagrams.net/.
+To edit it, download the <a download href="readme/btcpayment_process.drawio">diagram file</a> and edit it with the https://app.diagrams.net/ web application, or you may run the application from [source](https://github.com/jgraph/drawio) if you wish.
--- a/docs/capsul.webp
+++ b/docs/capsul.webp
--- a/docs/configuration.md
+++ b/docs/configuration.md
@ -0,0 +1,89 @@
+# Configuring Capsul-Flask
+
+Create a `.env` file to set up the application configuration:
+
+```
+nano .env
+```
+
+You can enter any environment variables referenced in [`__init__.py`](../capsulflask/__init__.py) to this file.
+
+For example you may enter your SMTP credentials like this:
+```
+MAIL_USERNAME=forest@nullhex.com
+MAIL_DEFAULT_SENDER=forest@nullhex.com
+MAIL_PASSWORD=**************
+```
+
+## <a name="example"></a>Example configuration from capsul.org (production):
+
+```
+#LOG_LEVEL=DEBUG
+
+BASE_URL="https://capsul.org"
+
+# hub url is used by the SPOKE_MODE to contact the hub. Since this server is the hub,
+# this is fine. In fact it runs into problems (routing related?) when I set it to capsul.org.
+# similarly the baikal "spoke" (set up in the hosts table in the db) has "http://localhost:5000" as the https_url
+HUB_URL="http://localhost:5000"
+
+HUB_MODE_ENABLED="t"
+SPOKE_MODE_ENABLED="t"
+HUB_MODEL="capsul-flask"
+SPOKE_MODEL="shell-scripts"
+SPOKE_HOST_ID="baikal"
+SPOKE_HOST_TOKEN="<redacted>"
+HUB_TOKEN="<redacted>"
+
+# smtp.. see https://flask-mail.readthedocs.io/en/latest/#configuring-flask-mail
+MAIL_SERVER="smtp.nullhex.com"
+
+# MAIL_USE_SSL means SMTP with STARTTLS
+MAIL_USE_SSL=true
+
+# MAIL_USE_TLS means SMTP wrapped in TLS
+MAIL_USE_TLS=false
+
+MAIL_PORT="465"
+MAIL_USERNAME="capsul@nullhex.com"
+MAIL_PASSWORD="<redacted>"
+MAIL_DEFAULT_SENDER="capsul@nullhex.com"
+
+# stripe
+STRIPE_SECRET_KEY="sk_live_<redacted>"
+STRIPE_PUBLISHABLE_KEY="pk_live_tGDHY7kBwqC71b4F0N7LZdGl00GZOw0iNJ"
+
+# internal
+SECRET_KEY="<redacted>"
+POSTGRES_CONNECTION_PARAMETERS="sslmode=verify-full sslrootcert=letsencrypt-root-ca.crt host=postgres.cyberia.club port=5432 ...<redacted>"
+
+
+# btcpay server
+BTCPAY_URL="https://beeteeceepae2.cyberia.club"
+BTCPAY_PRIVATE_KEY='-----BEGIN EC PRIVATE KEY-----\n<redacted>\n-----END EC PRIVATE KEY-----'
+```
+
+## <a name="config_that_lives_in_db"></a>Configuration-type-stuff that lives in the database 
+
+  - `hosts` table:
+    - `id` (corresponds to `SPOKE_HOST_ID` in the config)
+    - `https_url`
+    - `token` (corresponds to `SPOKE_HOST_TOKEN` in the config)
+  - `os_images` table:
+    - `id` 
+    - `template_image_file_name`
+    - `description`
+    - `deprecated`
+  - `vm_sizes` table:
+    - `id` 
+    - `dollars_per_month`
+    - `memory_mb`
+    - `vcpus`
+    - `bandwidth_gb_per_month`
+    
+## <a name="docker_secrets"></a>Loading variables from files (docker secrets)
+
+To support [Docker Secrets](https://docs.docker.com/engine/swarm/secrets/), you can also load secret values from files – for example, to load `MAIL_PASSWORD` from `/run/secrets/mail_password`, set
+```sh
+MAIL_PASSWORD_FILE=/run/secrets/mail_password
+```
--- a/docs/database.md
+++ b/docs/database.md
@ -0,0 +1,50 @@
+# capsul-flask's relationship to its Database Server
+
+Capsul has a ["hub and spoke" architecture](./architecture.md). The "Hub" runs the web application and talks to the Postrges database, while the "Spoke"s are responsible for creating/managing virtual machines. 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.
+
+The Postgres connections parameters are [configurable](./configuration.md).
+
+## <a name="schema_management"></a>Database schema management (schema versions)
+
+capsul-flask has a concept of a schema version. When the application starts, it will query the database for a table named `schemaversion` that has one row and one column (`version`). If the `version` it finds is not equal to the `desiredSchemaVersion` variable set in `db.py`, it will run  migration scripts from the `schema_migrations` folder one by one until the `schemaversion` table shows the correct version.
+
+For example, the script named `02_up_xyz.sql` should contain code that migrates the database from schema version 1 to schema version 2. Likewise, the script `02_down_xyz.sql` should contain code that migrates from schema version 2 back to schema version 1.
+
+**IMPORTANT: if you need to make changes to the schema, make a NEW schema version. DO NOT EDIT the existing schema versions.**
+
+In general, for safety, schema version upgrades should not delete data. Schema version downgrades will simply throw an error and exit for now. 
+
+## <a name="manual_queries"></a>Running manual database queries
+
+You can manually mess around with the database like this:
+
+```
+pipenv run flask cli sql -f test.sql
+```
+
+```
+pipenv run flask cli sql -c 'SELECT * FROM vms'
+```
+
+This one selects the vms table with the column name header:
+
+```
+pipenv run flask cli sql -c "SELECT string_agg(column_name::text, ', ') from information_schema.columns WHERE table_name='vms'; SELECT * from vms"
+```
+
+How to modify a payment manually, like if you get a chargeback or to fix customer payment issues:
+
+```
+$ pipenv run flask cli sql -c "SELECT id, created, email, dollars, invalidated from payments"
+1, 2020-05-05T00:00:00, forest.n.johnson@gmail.com, 20.00, FALSE
+
+$ pipenv run flask cli sql -c "UPDATE payments SET invalidated = True WHERE id = 1"
+1 rows affected.
+
+$ pipenv run flask cli sql -c "SELECT id, created, email, dollars, invalidated from payments"
+1, 2020-05-05T00:00:00, forest.n.johnson@gmail.com, 20.00, TRUE
+```
+
+## how to view the logs on the database server (legion.cyberia.club)
+
+`sudo -u postgres pg_dump capsul-flask | gzip -9 > capsul-backup-2021-02-15.gz`
--- a/docs/deployment.md
+++ b/docs/deployment.md
@ -0,0 +1,87 @@
+# Deploying Capsul on a server
+
+Capsul has a ["hub and spoke" architecture](./architecture.md). The "Hub" runs the web application and talks to the Postrges database, while the "Spoke"s are responsible for creating/managing virtual machines. 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.
+
+## <a name="spoke_mode_prerequisites"></a>Installing prerequisites for Spoke Mode
+
+On your spoke (see [Architecture](./architecture.md) You'll need `libvirtd`, `dnsmasq`, and `qemu-kvm`, plus a `/tank` diectory with some operating system images in it:
+
+```
+sudo apt install libvirt-daemon-system virtinst git dnsmasq qemu qemu-kvm
+sudo mkdir -p /var/www /tank/{vm,img,config}
+sudo mkdir -p /tank/img/debian/10
+cd !$
+sudo wget https://cloud.debian.org/images/cloud/buster/20201023-432/debian-10-genericcloud-amd64-20201023-432.qcow2 -O root.img.qcow2
+```
+
+TODO: network set-up
+TODO: cyberia-cloudinit.yml
+
+## Deploying capsul-flask
+
+### <a name="deploy_manually"></a>Manually
+
+Follow the [local set-up instructions](./local-set-up.md) on your server. 
+
+Make sure to set `BASE_URL` correctly, generate your own secret tokens, and
+configure your own daemon management for the capsul-flask server (e.g. writing
+init scripts, or SystemD unit files).
+
+Use the suggested `gunicorn` command (with appropriately-set address and port),
+instead of `flask run`, to launch the server.
+
+For example, here is the SystemD service unit file we use in production for `capsul.org`:
+
+```
+[Unit]
+Description=capsul-flask virtual machines as a service
+After=network.target
+
+[Service]
+ExecStart=/usr/local/bin/pipenv run gunicorn --bind 127.0.0.1:5000 -k gevent --worker-connections 1000 app:app
+Restart=on-failure
+WorkingDirectory=/opt/capsul-flask
+
+[Install]
+WantedBy=multi-user.target
+
+```
+
+TODO: cron runner is required to run maintenance tasks for now, but in the future we want to build this into the python based task scheduler. 
+
+### <a name="coop_cloud_docker"></a> Using Co-op Cloud's vanilla Docker Swarm configuration
+
+Download the Co-op Cloud swarm `compose.yml`:
+
+```sh
+wget https://git.autonomic.zone/coop-cloud/capsul/src/branch/main/compose.yml
+```
+
+Optionally, download add-on compose files for Stripe, BTCPay, and Spoke Mode:
+
+```sh
+wget https://git.autonomic.zone/coop-cloud/capsul/src/branch/main/compose.{stripe,btcpay,spoke}.yml
+```
+
+Then, create a `.env` file and configure appropriately -- you probably want to
+define most settings in [the Co-op Cloud `.envrc.sample`
+file](https://git.autonomic.zone/coop-cloud/capsul/src/branch/main/.envrc.sample).
+
+Load the environment variables (using Python `direnv`, or a manual `set -a && source .env && set +a`), insert any necessary secrets, then run the deployment:
+
+```sh
+docker stack deploy -c compose.yml -c compose.stripe.yml your_capsul
+```
+
+(where you'd add an extra `-c compose.btcpay.yml` for each optional compose file
+you want, and set `your_capsul` to the "stack name" you want).
+
+TODO: cron runner
+
+### <a name="coop_cloud_abra"></a> Using Co-op Cloud's `abra` deployment tool
+
+Follow [the guide in the README for the Co-op Cloud capsul package](https://git.autonomic.zone/coop-cloud/capsul/).
+
+### Using docker-compose
+
+TODO
--- a/docs/images/btcpay_sin_pairing.jpg
+++ b/docs/images/btcpay_sin_pairing.jpg
--- a/docs/images/btcpayment_process.drawio
+++ b/docs/images/btcpayment_process.drawio
--- a/docs/images/btcpayment_process.png
+++ b/docs/images/btcpayment_process.png
--- a/docs/images/generate_btcpay_keys.py
+++ b/docs/images/generate_btcpay_keys.py
--- a/docs/images/hub-and-spoke.xml
+++ b/docs/images/hub-and-spoke.xml
--- a/docs/images/hub-and-spoke1.png
+++ b/docs/images/hub-and-spoke1.png
--- a/docs/images/hub-and-spoke2.png
+++ b/docs/images/hub-and-spoke2.png
--- a/docs/images/paired.jpg
+++ b/docs/images/paired.jpg
--- a/docs/local-set-up.md
+++ b/docs/local-set-up.md
@ -0,0 +1,68 @@
+# How to run Capsul locally
+
+## <a name="manually"></a>Manually
+
+Ensure you have the pre-requisites for the psycopg2 Postgres database adapter package:
+
+```sh
+sudo apt install python3-dev libpq-dev
+pg_config --version
+```
+
+Ensure you have the wonderful `pipenv` python package management and virtual environment cli:
+
+```sh
+sudo apt install pipenv
+```
+
+Create python virtual environment and install packages:
+
+```sh
+pipenv install
+```
+
+Run an instance of Postgres (I used docker for this, you can use whatever you want, point is its listening on `localhost:5432`):
+
+```sh
+docker run --rm -it -e POSTGRES_PASSWORD=dev -p 5432:5432 postgres
+```
+
+Run the app 
+
+```sh
+pipenv run flask run
+```
+
+or, using Gunicorn:
+
+```sh
+pipenv run gunicorn --bind 127.0.0.1:5000 -k gevent --worker-connections 1000 app:app
+```
+
+Note that by default when running locally, the `SPOKE_MODEL` is set to `mock`, meaning that it won't actually try to spawn vms.
+
+## Crediting your account
+
+Once you log in for the first time, you will want to give yourself some free capsulbux so you can create fake capsuls for testing. 
+
+```sh
+pipenv run flask cli sql -c "INSERT INTO payments (email, dollars) VALUES ('<your email address here>', 20.00)"
+```
+
+## Running scheduled tasks:
+
+```sh
+pipenv run flask cli cron-task
+```
+
+## <a name="docker_compose"></a>Run locally with docker-compose
+
+If you have Docker and Docker-Compose installed, you can use the
+`3wordchant/capsul-flask` Docker image to launch capsul-flask, and a Postgres
+database server, for you:
+
+```sh
+docker-compose up
+```
+
+`capsul-flask` will read settings from your `.env` file as usual; you can set any of the options mentioned in the [configuration documentation](./configuration.md).
Author	SHA1	Message	Date
3wordchant	72c04d8495	Docker image, & local development docker-compose.yml (#2 ) All checks were successful continuous-integration/drone/push Build is passing Details Adds: - a Docker image, which can be used in both development and production - a `docker-compose.yml` file for local development (could probably be adapted for production deployments) Testing: - `git checkout docker` - `docker-compose up` - pray 🙏 - go to http://localhost:5000 ## App architecture I added the ability to load secret config variables (`HUB_TOKEN`, `STRIPE_SECRET_KEY` etc) from files, to support [Docker Secrets](https://docs.docker.com/engine/swarm/secrets/) natively. The code should probably log an error if a specified `HUB_TOKEN_FILE` doesn't exist instead of failing silently.. ## Docker architecture This uses a multi-stage build to reduce the size of the final image -- having pipenv install to a predefined virtualenv, and then copying that over. The compose file doesn't include a definition for a cron runner service, and I haven't tested running one yet. Here be dragons! You can rebuild the image locally using `docker-compose build`, but this isn't required for changes to the app code, only if you edit the `Dockerfile`, or want to publish your image for use on a swarm server (in which case you will need to edit the image name to put in your own Docker hub credentials). Currently, the image is rebuilt (should set up auto-tagging..) and published with every push to this 3wordchant/capsul-flask fork. Reviewed-on: https://git.autonomic.zone/3wordchant/capsul-flask/pulls/2 Co-authored-by: 3wordchant <3wordchant@noreply.git.autonomic.zone> Co-committed-by: 3wordchant <3wordchant@noreply.git.autonomic.zone>	2021-07-22 01:18:10 +02:00
3wordchant	5bb76173dd	Add custom themes, THEME setting, basic "yolocolo" theme (#7 ) Specify `THEME=yourtheme`, add some HTML files in `capsulflask/theme/yourtheme` 👌 We probably want to reduce copypasta in the current `yolocolo` theme by using template inheritance, at some point. Reviewed-on: https://git.autonomic.zone/3wordchant/capsul-flask/pulls/7 Co-authored-by: 3wordchant <3wordchant@noreply.git.autonomic.zone> Co-committed-by: 3wordchant <3wordchant@noreply.git.autonomic.zone>	2021-07-22 01:15:39 +02:00
forest	8c0c613392	Merge remote-tracking branch 'threewordchant/master'	2021-07-21 16:47:46 -05:00
forest	50ee1144f9	Merge remote-tracking branch 'threewordchant/master'	2021-07-21 16:46:50 -05:00
3wc	c4ba5ea197	Merge branch 'master' of ssh://git.autonomic.zone:2222/3wordchant/capsul-flask	2021-07-21 23:46:37 +02:00
forest	08eb38dc57	correctly enforce affordable_vm_sizes post form submission	2021-07-21 16:45:53 -05:00
3wc	33f4551cf4	Merge branch 'docs-reshuffle'	2021-07-21 23:44:42 +02:00
3wc	0fa7fb28b5	Split README up into separate files, plus: * forest's ReadMe docs changes * add Configuration-type-stuff that lives in the database	2021-07-21 23:43:44 +02:00
forest	be6e72028c	define BTCPAY_ENABLED based on URL and btcpay key, pass it explicitly	2021-07-21 23:43:44 +02:00
3wc	bf7487f4f0	Don't load /btcpay if BTCPAY_PRIVATE_KEY un-set	2021-07-21 23:43:44 +02:00
3wc	8b0ce0ba71	Hide the BTCPay link if BTCPAY_PRIVATE_KEY un-set	2021-07-21 23:43:44 +02:00
3wc	bca570882e	Add load_config_vars context processor.. ..to allow accessing config variables in the templates. This removes the need for adding config variables manually to template contexts.	2021-07-21 23:43:44 +02:00
forest	f3ae9aae23	remove class="small" from pricing table cuz normal size fits fine	2021-07-21 23:43:44 +02:00
3wc	827ca4a50b	Auto-generate the pricing table from the database	2021-07-21 23:43:44 +02:00
3wordchant	f999adaf71	Add VMs to the database even with HUB_MODE=mock (#6 ) https://todo.cyberia.club/~cyberia/services/83 Co-authored-by: 3wc <3wc.cyberia@doesthisthing.work> Co-authored-by: forest <forest.n.johnson@gmail.com> Reviewed-on: https://git.autonomic.zone/3wordchant/capsul-flask/pulls/6 Co-authored-by: 3wordchant <3wordchant@noreply.git.autonomic.zone> Co-committed-by: 3wordchant <3wordchant@noreply.git.autonomic.zone>	2021-07-21 23:26:10 +02:00
3wc	8f2becb9ee	Fix SyntaxWarning on `is not ""` `capsulflask/__init__.py:143: SyntaxWarning: "is not" with a literal. Did you mean "!="?`	2021-07-21 21:51:50 +02:00
3wordchant	f848eda931	Merge pull request 'Disable BTCPay in the interface, if BTCPAY_PRIVATE_KEY is un-set' (#3 ) from optional-btcpay into master Reviewed-on: https://git.autonomic.zone/3wordchant/capsul-flask/pulls/3	2021-07-21 20:20:40 +02:00
3wordchant	46f49e8d8f	Merge pull request 'Auto-generate the pricing table from the database' (#4 ) from generated-prices into master Reviewed-on: https://git.autonomic.zone/3wordchant/capsul-flask/pulls/4	2021-07-21 19:32:09 +02:00
forest	36329796f0	define BTCPAY_ENABLED based on URL and btcpay key, pass it explicitly	2021-07-21 12:12:41 -05:00
forest	28271ee852	remove class="small" from pricing table cuz normal size fits fine	2021-07-21 11:53:44 -05:00
3wc	7923f3a99f	Auto-generate the pricing table from the database	2021-07-21 12:19:28 +02:00
3wc	7ed847251f	Don't load /btcpay if BTCPAY_PRIVATE_KEY un-set	2021-07-21 00:22:58 +02:00
3wc	e3a4776a5d	Hide the BTCPay link if BTCPAY_PRIVATE_KEY un-set	2021-07-21 00:20:38 +02:00
3wc	357d99cb91	Add load_config_vars context processor.. ..to allow accessing config variables in the templates. This removes the need for adding config variables manually to template contexts.	2021-07-21 00:19:38 +02:00
forest	b8279d7491	add about ssh link to faq	2021-07-19 18:09:02 -05:00