Merge pull request #234 from hydroserver2/v2-deployment

HydroServer V1

Author: kjlippold

.coveragerc

@@ -1,28 +1,37 @@
-# The base URL for the deployment.
-PROXY_BASE_URL = http://127.0.0.1:8000
-APP_CLIENT_URL = http://127.0.0.1:5173  # In production environments, this should generally be the same as the PROXY_BASE_URL.
-ALLOWED_HOSTS = 127.0.0.1,localhost
-
 # Deployment Settings
-SECRET_KEY =  # This is required by Django. Keep this value secret.
-DEBUG = True  # This should be set to False in production environments.
-DEPLOYMENT_BACKEND = aws  # Use 'aws' for AWS deployments, otherwise use 'local'
-DISABLE_ACCOUNT_CREATION = False  # Set this to True if you want administrative users to manage the creation of all other user accounts.
-
-# The connection URL so the timescaleDB instance can connect to the PostgreSQL database
-DATABASE_URL = postgresql://postgres:password@localhost:5432/tsdb  # Update this value to connect to your PostgreSQL database for this deployment.
-
-# Email Settings. This email is used for user account verification and password reset.
-EMAIL_HOST =
-EMAIL_PORT =
-EMAIL_HOST_USER =
-EMAIL_HOST_PASSWORD =
-ADMIN_EMAIL =
-
-# OAuth Settings. Leave these settings blank to disable any of these services.
-OAUTH_GOOGLE_CLIENT =
-OAUTH_GOOGLE_SECRET =
-OAUTH_ORCID_CLIENT =
-OAUTH_ORCID_SECRET =
-OAUTH_HYDROSHARE_CLIENT =
-OAUTH_HYDROSHARE_SECRET =
+
+PROXY_BASE_URL =             # The base URL HydroServer will be served from.
+ALLOWED_HOSTS =              # Defaults to the host of PROXY_BASE_URL.
+DEBUG =                      # True/False: This should be set to False in production environments.
+DEPLOYMENT_BACKEND =         # Use 'aws' or 'gcp' for cloud deployments, otherwise use 'local'.
+SECRET_KEY =                 # This is required by Django. Keep this value secret.
+DEFAULT_SUPERUSER_EMAIL =    # The email of the admin user created during initial startup.
+DEFAULT_SUPERUSER_PASSWORD = # The password of the admin user created during initial startup.
+ENABLE_AUDITS =              # True/False: This will track user activity in the sta app.
+
+
+# Account Settings
+
+SMTP_URL =                  # A connection to the SMTP server Django will send account related emails from.
+DEFAULT_FROM_EMAIL =        # The email address Django will send account related emails from.
+ACCOUNT_SIGNUP_ENABLED =    # True/False: Controls whether new users can create their own accounts.
+ACCOUNT_OWNERSHIP_ENABLED = # True/False: Controls whether new users can create/own workspaces.
+SOCIALACCOUNT_SIGNUP_ONLY = # True/False: Controls whether non-social account creation is supported.
+
+
+# Database Settings
+
+DATABASE_URL =       # A connection to the PostgreSQL or TimescaleDB server HydroServer will use.
+CONN_MAX_AGE =       # Controls how long Django will hold database connections open before closing them.
+CONN_HEALTH_CHECKS = # True/False: Controls whether connection health checks are enabled.
+SSL_REQUIRED =       # True/False: Controls whether Django will connect to the database using SSL.
+
+
+# Storage Settings
+
+MEDIA_BUCKET_NAME =     # The name of the AWS or GCP bucket photos will be stored in.
+STATIC_BUCKET_NAME =    # The name of the AWS or GCP bucket static files will be stored in.
+APP_CLIENT_URL =        # The base URL media and static files will be served from, if not the PROXY_BASE_URL.
+AWS_CLOUDFRONT_KEY =    # The AWS CloudFront key used to generate signed photo URLs.
+AWS_CLOUDFRONT_KEY_ID = # The ID of the AWS CloudFront key used to generate signed photo URLs.
+GS_PROJECT_ID =         # The ID of the GCP project HydroServer is deployed to.

.ebextensions/django.config

@@ -2,7 +2,7 @@ name: Build and Push HydroServer Docker Image to GHCR
 
 on:
   release:
-    types: [created]
+    types: [created, edited]
 
 jobs:
   build:

.env.example

@@ -3,14 +3,20 @@
 .pytest_cache
 __pycache__/
 db.sqlite3
+/static/
+!*/static/
+/media/
 staticfiles/
+/static
+!/static/**/
 *.db
 *test.ipynb
 *test.yaml
 **/launch.json
 .coverage
 coverage.txt
 photos/
+csrf_test.py
 
 # Elastic Beanstalk Files
 .elasticbeanstalk/*

.github/workflows/release.yaml

@@ -11,4 +11,6 @@ COPY . .
 
 EXPOSE 8000
 
-CMD ["gunicorn", "--bind", "0.0.0.0:8000", "hydroserver.wsgi:application"]
+ENV WORKERS=3
+
+CMD ["sh", "-c", "gunicorn --bind 0.0.0.0:8000 --workers ${WORKERS} hydroserver.wsgi:application"]