operations

This repository houses a collection of code artifacts, including Github actions, Github workflows, and essential docker-compose files. These resources are instrumental in facilitating efficient and automated staging and production deployments.

Running on docker

1. cd compose
2. In the /redis folder, create a random password for each redis service (replace PASSWORD). See /redis/example.*.conf files for required inputs.
3. Configure the environments for each service by creating your .env.* files. See example.env.* files for required inputs.
4. Create replica.key for mongodb:

   openssl rand -base64 756 > mongo/replica.key # create replica.key
   chmod 400 mongo/replica.key # read-only
   sudo chown 999:999 mongo/replica.key # change ownership

5. On Github generate a app and get the private key, place it in a file github/githubapp.private-key.pem.
6. Create an origin certificate on Cloudflare. Place both the .pem and .key files in the /nginx/ssl (make sure their name is the same as the DOMAIN in .env.nginx).
7. Allocate memswap:

   
   free -h                           # Check Existing Swap Space

sudo fallocate -l 32G /swapfile # Create a 32GB swap file sudo chmod 600 /swapfile # Set the correct permissions sudo mkswap /swapfile # Set up the swap file sudo swapon /swapfile # Enable the swap file

Verify Swap Space

swapon --show free -h

Persist the Swap File

echo '/swapfile swap swap defaults 0 0' | sudo tee -a /etc/fstab

6. Run `docker compose up -d`

<!-- ## Localhost

- Create a `.env` file with `HOST_NAME=docker.localhost`. See [.env.example](/.env.example).
- Generate a basic auth for a user using: `echo $(htpasswd -nB user)`
- Create a `userFile` file and paste the basic auth you generated. See [userFile.example](/userFile.example).
- Install [mkcert](https://github.com/FiloSottile/mkcert).
- If its the first mkcert install, run `mkcert -install`.
- Create the `/certs` folder using `mkdir certs`.
- Generate your origin certificates: `mkcert -cert-file certs/origin-cert.pem -key-file certs/origin-key.pem "docker.localhost" "*.docker.localhost"`
- Start docker: `docker compose up -d`
- Head over to [traefik.docker.localhost](https://traefik.docker.localhost)
- Enter the user and password from the basic auth.
- You should see your traefik dashboard. -->

<!-- ## Server w/ Cloudflare Origin Certificates

- Login to your server
- [Install Docker Engine with Ubuntu](https://docs.docker.com/engine/install/ubuntu/)
- Clone the repository. `git clone https://github.com/TogetherCrew/operations`
- Go into the folder: `cd operations`
- Create a `.env` file with `HOST_NAME=yourdomain.com`. See [.env.example](/.env.example).
- Generate a basic auth for a user using: `echo $(htpasswd -nB user)`. See [userFile.example](/userFile.example).
- Create a `userFile` file and paste the basic auth you generated. You can add multiple.
- Go to Cloudflare -> Your Domain -> SSL/TLS -> Origin Server, and Create Certificates.
- Create the `/certs` folder using `mkdir certs`.
- Create a file named `origin-cert.pem` and paste the Origin Certificate from Cloudflare.
- Create a file named `origin-key.pem` and paste the Origin Key from Cloudflare.
- Configure your DNS. For example:
|Type|Name|Content|Proxy status|TTL|
|-|-|-|-|-|
|A|yourdomain.com|123.456.789|True|Auto|
|CNAME|traefik|@|True|Auto|
- Start docker: `docker compose up -d`
- Head over to traefik.*yourdomain.com*
- Enter the user and password from the basic auth.
- You should see your traefik dashboard. -->

## Running Neo4j migrations

- Install [neo4j-migrations](https://michael-simons.github.io/neo4j-migrations/2.2.2/#cli) tool
- Create a file `.migrations.properties` under the db folder for neo4j based on `.migrations.properties.example`
- run the `neo4j-migrations apply` within `db` directory (the directory containing the `.migrations.properties`) to run neo4j migrations