Smol docs tweaks

Reviewed-on: https://git.autonomic.zone/3wordchant/capsul-flask/pulls/3

README.md

@@ -2,7 +2,7 @@
 
 ![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 developer by [Cyberia Computer Club](https://cyberia.club) for https://capsul.org
+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
 
 `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.
 

capsulflask/__init__.py

@@ -31,7 +31,6 @@ load_dotenv(find_dotenv())
 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 +71,7 @@ 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="")
 )
 
 app.config['HUB_URL'] = os.environ.get("HUB_URL", default=app.config['BASE_URL'])
@@ -140,10 +139,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'] is not "":
+  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.
@@ -219,7 +221,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 +245,3 @@ def url_for_with_cache_bust(endpoint, **values):
       values['q'] = current_app.config['STATIC_FILE_HASH_CACHE'][filename]
 
   return url_for(endpoint, **values)
-
-
-
-  

capsulflask/console.py

@@ -423,6 +423,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"], 

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
   )
 

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]
@@ -289,4 +293,4 @@ def success():
 #   except stripe.error.SignatureVerificationError:
 #     print("/payment/stripe/webhook returned 400: invalid signature")
 #     abort(400, "invalid signature")
-      
+      

capsulflask/static/style.css

@@ -241,7 +241,6 @@ thead {
   background: #bdc7b812;
 }
 td, th {
-
   padding: 0.1em 1em;
 }
 table.small td, table.small th {
@@ -378,4 +377,4 @@ footer {
   border: 1px solid rgba(255, 223, 155, 0.8);
   box-sizing: border-box;
   position: relative;
-}
+}

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>

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?

capsulflask/templates/pricing.html

@@ -6,21 +6,37 @@
   <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:
 

docs/local-set-up.md

@@ -65,5 +65,4 @@ database server, for you:
 docker-compose up
 ```
 
-docker-compose will read settings from your `.env` file; you can set any of the
-options mentioned in the [configuration documentation](./configuration.md).
+`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).