Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ajayvignesh01/server-tradeloop

Last synced: 6 days ago
JSON representation

Host: GitHub
URL: https://github.com/ajayvignesh01/server-tradeloop
Owner: ajayvignesh01
Created: 2024-03-07T00:59:02.000Z (10 months ago)
Default Branch: main
Last Pushed: 2024-03-11T23:37:00.000Z (10 months ago)
Last Synced: 2024-11-14T17:50:27.146Z (about 1 month ago)
Language: TypeScript
Size: 36.1 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # TradeLoop Server

## Server

- Set up a VPS using your desired provider. My favorite for cheap and reliable is [Hetzner's CAX11](https://www.hetzner.com/cloud/).

- We will be using Ubuntu 22.04 with Docker.

  - Most cloud providers offer an image with Docker pre-installed.

  - If that is not the case, you can follow the official guide on [Docker](https://docs.docker.com/engine/install/ubuntu/) to get it set up.

- After your server is set up, run the following commands from your local terminal:

  - `ssh root@your_server_domain`

  - `adduser newusername`

  - `usermod -aG docker newusername`

- Make sure to replace `your_server_domain` and `newusername` with your desired values.

- This will create a new user and allow access to run docker in detached mode.

- To apply these changes, restart the server.

## Docker

- SSH into the new user from above

- Clone this repository: `git clone --depth 1 https://github.com/ajayvignesh01/server-tradeloop`

- Copy your edge functions to the `./functions` directory.

- Build the container image: `docker compose up --build -d`

- Check if the server is working by making a post request to `your_server_ip:8000/hello-world`

## Domain

- You need to hava a domain set up on Cloudflare for this step.

- Navigate to the [Cloudflare Zero Trust Dashboard](https://one.dash.cloudflare.com/).

- Under the Networks tab, click on Tunnels, and create a new tunnel.

- Pick Docker as your environment, and you will be shown a command.

- Insert `-d --network host` after `docker run` and run it in your VPS'

- Back on Cloudflare, configure your public hostname and enter http://localhost:8000 for service.

- You should now be able to access your server using your own domain without exposing the VPS IP address.

## Auto Deploy

### Authenticate Git Client on VPS

1. Generate a new SSH key pair on your VPS

    - SSH into your server as the relevant user

    - Run `ssh-keygen -t ed25519 -C "[email protected]"` to generate a new SSH key pair.

    - Accept the default file location `~/.ssh/id_ed25519` and leave the passphrase empty (just press Enter).

2. Add the SSH public key to your GitHub account:

    - Copy the contents of the `~/.ssh/id_ed25519.pub` file on your VPS.

    - In your GitHub account, go to Settings > SSH and GPG keys and click on New SSH key.

    - Provide a title for the key (e.g., "VPS Server") and paste the public key contents in the "Key" field.

3. Add GitHub host key on your VPS

    - On your VPS server, run the following command to fetch the host key of github.com `ssh-keyscan -H github.com`.

    - Open the `~/.ssh/known_hosts` file on your VPS server, and add the host keys.

    - Run `ssh -T [email protected]` to check, it should output `Hi your_username! You've successfully authenticated, but GitHub does not provide shell access`

### Authenticate VPS SSH on GitHub

1. Set up SSH Key for Authentication

    - Generate a new SSH key pair on your local machine `ssh-keygen -t ed25519 -C "[email protected]"`.

    - Accept the default file location `~/.ssh/id_ed25519` and leave the passphrase empty (just press Enter).

    - Copy the public key (id_ed25519.pub) to your VPS server by appending it to the authorized_keys file in the ~/.ssh directory of the relevant user.

2. Store the SSH Private Key as a GitHub Secret

    - In your GitHub repository, go to Settings > Secrets > Actions and click on New repository secret.

    - Name the secret SSH_PRIVATE_KEY and paste the contents of the private key file (id_ed25519) as the value.

    - We will use this in our GitHub Action to authenticate and connect to our VPS server through SSH.

3. Obtain VPS SSH Host Key

    - Run  `ssh-keyscan -H your_server_domain` on your local machine.

    - Add the host keys to a new secret in your GitHub repository settings (e.g., SSH_KNOWN_HOSTS).

    - We will use this to tell our GitHub Action that the VPS server is a known host and we can securely connect to it.

### Create GitHub Action

- Edit the `/.github/workflows/deploy.yml` file according to your needs.

- This will intiate a zero-downtime redeployment on pushes to main branch.

## Additional Configuration

### Environment Variables

- Rename `.env.example` to `.env` and input your environment vairables.

- Make sure to add any new env variables to the `docker-compose.yml` as well.

### JWT Verification

- You can enable or disable this for all functions by editing the SUPABASE_FUNCTIONS_VERIFY_JWT env variable.

- In the future you will be able to do this on a per function basis.