Dev

.github/workflows/prod-deploy.yml

@@ -0,0 +1,23 @@
+name: Prod Deploy
+on:
+  push:
+    branches:
+      - main
+jobs:
+  deploy:
+    name: Deploy to Prod
+    runs-on: ubuntu-latest
+    concurrency: deploy-group    # optional: ensure only one action runs at a time
+    steps:
+      - name: Execute remote SSH commands using password
+        uses: appleboy/ssh-action@v1
+        with:
+          host: ${{ secrets.HOST }}
+          username: ${{ secrets.USERNAME }}
+          password: ${{ secrets.PASSWORD }}
+          script: |
+            cd /home/deploy/source-be
+            git checkout main
+            git pull
+            ./build.sh
+            sudo /bin/systemctl restart source-be

.github/workflows/staging-deploy.yml

@@ -0,0 +1,29 @@
+name: Staging Deploy
+on:
+  push:
+    branches:
+      - dev
+jobs:
+  deploy:
+    name: Deploy to Staging
+    runs-on: ubuntu-latest
+    concurrency: deploy-group
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Connect to Tailscale
+        uses: tailscale/github-action@v4
+        with:
+          oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }}
+          oauth-secret: ${{ secrets.TS_OAUTH_SECRET }}
+          tags: tag:ci
+          ping: mervstation.tail4f070.ts.net
+
+      - name: Execute remote SSH commands
+        run: |
+          ssh -o StrictHostKeyChecking=no merv@mervstation.tail4f070.ts.net '
+            cd /home/merv/Developer/source-be
+            git pull
+            ./build.sh
+            sudo /bin/systemctl restart source-be
+          '

.gitignore

@@ -8,6 +8,7 @@ source-users
 dev/dev.clj
 .nrepl-port
 target/
+resources/admins_encrypted.json
 
 .db
 admins.json

.java-version

@@ -0,0 +1 @@
+21

README.md

@@ -2,15 +2,22 @@
 
 This is the backend for the Source platform. You can find documentation on setup for development below.
 
+## Dependencies
+
+- >= openjdk version 16.
+
 ## Development setup
 
 - Pull the project from GitHub.
 - Create a .env file containing the following required information:
 
 ```.env
 SUPER_SECRET_KEY [string, minimum 32 characters]
+EMAIL_USERNAME [string, email username used for sending emails]
+EMAIL_PASSWORD [string, email password used for sending emails]
 GOOGLE_CLIENT_ID [string, from Google Console]
 GOOGLE_CLIENT_SECRET [string, from Google Console]
+DATABASE_URL [string, connection URL to Postgres instance, excluding database name and trailing forward slash]
 ```
 
 - Run the provided shell script with `./nrepl.sh` to start your nrepl server. For this, you will need the required nrepl alias in `.clojure/deps.edn`.
@@ -19,9 +26,9 @@ When you have made changes, you can restart the server by evaluating `server/res
 
 ## Database Migration
 
-Database migration is handled using the provided migrate.sh shell script.
-You should have a db directory and ensure your configuration is pointing to it. The default is `.db/` in the root, 
-this can be configured with the `DATABASE_DIR` variable in the environment.
+Database migration is handled using the provided `migrate.sh` shell script.
+You need to have a Postgresql connection string in order to run migrations,
+this can be configured with the `DATABASE_URL` variable in the environment.
 
 The migration system makes use of the kepler/mallard library, take a look at their [docs](https://github.com/kepler16/mallard) to find out more on how it works.
 The datasource you will be operating on is passed in as context to the run-up and run-down functions.
@@ -56,3 +63,38 @@ We are making use of cognitect-labs/test-runner for running our tests. Run the p
 Unit tests are written and placed in clj files in `tests/source-be/`. These files should have the `_test` postfix (e.g. google_auth_test.clj) and tests should be 
 written per namespace and cover all important functions.
 
+## Production Setup
+
+- Pull the project from GitHub and navigate to its directory.
+- Ensure you have Java installed, minimum openjdk version 16.
+- Create a .env file containing the following required information:
+
+```.env
+# These values are secrets, ensure they are not exposed anywhere else on your system
+SUPER_SECRET_KEY [string, minimum 32 characters]
+EMAIL_USERNAME [string, email username used for sending emails]
+EMAIL_PASSWORD [string, email password used for sending emails]
+GOOGLE_CLIENT_ID [string, from Google Console]
+GOOGLE_CLIENT_SECRET [string, from Google Console]
+DATABASE_URL [string, connection URL to Postgres instance, excluding database name and trailing forward slash]
+
+# These values are required for config and compiling the project
+ENV [string, "dev" | "staging" | "prod"] # This should match your config file, e.g. if ENV is "staging", your config file should be called staging_config.edn
+JAVA_CMD [string, path pointing to your Java executable]
+```
+
+- If there isn't already a `config.edn` file for your target environment in the `resources/` directory, create a config file using the given `resources/dev_config.edn`
+as a template as shown below:
+```bash
+cp resources/config.edn resources/{env_name}_config.edn
+```
+where `{env_name}` is the value of the `ENV` variable set in your `.env`.
+You can configure everything for your machine inside your config.edn file, alternatively, you can configure everything marked with `#env` from `{env_name}_config.edn` 
+within your `.env` file.
+
+- If everything before this point is set up correctly, you are ready to begin the next steps.
+
+- Run `./build.sh` to the compile the project.
+- Run `./start.sh` to start the server. The server will use the config according to the specified environment in `.env` and will run migrations before starting.
+
+The logs will be displayed when the server is run. If you are running the server via a systemd service, you can find them by running `journalctl -u {servicename}.service`.