Update Themes Branch

.github/workflows/build-and-deploy.yml

@@ -0,0 +1,79 @@
+name: Build and Publish Docker Images
+
+on:
+  workflow_dispatch:
+  push:
+    paths:
+      - frontend/**
+      - backend/**
+    branches:
+      - master
+      - dev
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+    strategy:
+      matrix:
+        component: [frontend, backend]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Log in to GHCR
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Get Commit Hash
+        id: get_commit_hash
+        run: echo "hash=$(git rev-parse --short HEAD)" >> $GITHUB_ENV
+
+      - name: Set Docker Tags
+        id: set_tags
+        run: |
+          if [ "${{ github.ref_name }}" == "master" ]; then
+            echo "tag=latest" >> $GITHUB_ENV
+          elif [ "${{ github.ref_name }}" == "dev" ]; then
+            echo "tag=dev" >> $GITHUB_ENV
+          else
+            echo "Unknown branch: ${{ github.ref_name }}"
+            exit 1
+          fi
+
+      - name: Build and push Docker image to GHCR
+        uses: docker/build-push-action@v3
+        with:
+          context: ./${{ matrix.component }}
+          file: ./${{ matrix.component }}/Dockerfile
+          build-args: |
+            COMMIT_HASH=${{ env.hash }}
+          push: true
+          tags: |
+            ghcr.io/loudbooks/pastebook-${{ matrix.component }}:${{ env.tag }}
+            ghcr.io/loudbooks/pastebook-${{ matrix.component }}:${{ env.hash }}
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_TOKEN }}
+
+      - name: Build and push Docker image to Docker Hub
+        uses: docker/build-push-action@v3
+        with:
+          context: ./${{ matrix.component }}
+          file: ./${{ matrix.component }}/Dockerfile
+          build-args: |
+            COMMIT_HASH=${{ env.hash }}
+          push: true
+          tags: |
+            ${{ secrets.DOCKER_USERNAME }}/pastebook-${{ matrix.component }}:${{ env.tag }}
+            ${{ secrets.DOCKER_USERNAME }}/pastebook-${{ matrix.component }}:${{ env.hash }}

.gitignore

@@ -1,41 +1,5 @@
-HELP.md
-.gradle
-build/
-!gradle/wrapper/gradle-wrapper.jar
-!**/src/main/**/build/
-!**/src/test/**/build/
-
-### STS ###
-.apt_generated
-.classpath
-.factorypath
-.project
-.settings
-.springBeans
-.sts4-cache
-bin/
-!**/src/main/**/bin/
-!**/src/test/**/bin/
-
-### IntelliJ IDEA ###
+.*
+!.gitignore
+docker-compose.yml
 .idea
-*.iws
-*.iml
-*.ipr
-out/
-!**/src/main/**/out/
-!**/src/test/**/out/
-
-### NetBeans ###
-/nbproject/private/
-/nbbuild/
-/dist/
-/nbdist/
-/.nb-gradle/
-
-### VS Code ###
-.vscode/
-
-### Kotlin ###
-.kotlin
-src/main/resources/application.properties
+/backend/target

README.md

@@ -1,9 +1,86 @@
-<div align="center">
-  <h1>PasteBook</h1>
-  <p>PasteBook is an aesthetic, effortless way to share your blocks of text, and respects your privacy by automatically deleting your pastes.</p>
-
-  ![Static Badge](https://img.shields.io/badge/Website-brightgreen?style=for-the-badge&link=https%3A%2F%2Fpastebook.dev)
-
-</div>
-
-PasteBook was created with the intention of being used as a quick-and-easy solution to sharing temporary data with others. All data is to be deleted after 24 hours, unless specified otherwise.
+# PasteBook 
+An easy on the eyes, portable, lightning fast pastebin written in Svelte and Rust.
+
+### Prerequisites
+Docker. Both the frontend and backend are to be installed with Docker. You can learn more [here](https://www.docker.com).
+
+## Installation
+The following is a guide to get PasteBook running on your system under your domain with SSL. All of this was tested on Ubuntu Linux.
+
+### Preparation
+Download `docker-compose.yml` [here](https://github.com/Loudbooks/PasteBook/blob/master/docker-compose.yml).
+
+### Configuration
+> [!CAUTION]
+> Do not modify `docker-compose.yml`. You will break things.
+
+Create a file by the name of `.env` in the same directory as `docker-compose.yml`. Add the following.
+```env
+TITLE=
+DESCRIPTION=
+DISABLE_NEW=
+FAVICON_URL=
+MAX_PAYLOAD_SIZE=
+```
+
+All of the following are optional. You can leave it all blank, or not even have a `.env` file at all. 
+
+`TITLE` - The title to be used around PasteBook.
+
+`DESCRIPTION` - The description to be used in embeds and on the home page of PasteBook.
+
+`DISABLE_NEW` - Disables the new paste page. API is still accessible.
+
+`FAVICON_URL` - The URL that the favicon will be provided with. 
+
+`MAX_PAYLOAD_SIZE` - The maximum paste size in megabytes.
+
+### Creation
+Run the following.
+```bash
+docker compose up -d
+```
+
+Awesome! PasteBook is now running.
+
+## Nginx Configuration
+In order to run PasteBook under a domain, you will need to use a reverse proxy. The following will serve as a guide to setting up Nginx.
+
+### Prerequisites
+- PasteBook is fully installed with the instructions above.
+- A working Nginx installation. Learn more [here](https://nginx.org/en/linux_packages.html#instructions).
+- A working Certbot installation. Learn more [here](https://certbot.eff.org/instructions?ws=nginx&os=snap).
+## Nginx Preparation
+Navigate to `/etc/nginx/sites-enabled`.
+
+## Domain Preparation
+You will need to create a DNS A record pointing to your machine with the root and with the `api.` prefix. I use CloudFlare.
+
+### Configuration 
+Download `pastebook.conf` [here](https://github.com/Loudbooks/PasteBook/blob/master/pastebook.conf).
+
+`<DOMAIN>` - Change this to your domain name. For example, mine is `pastebook.dev`.
+
+### SSL Configuration
+Run the following, with `<DOMAIN>` changed to your domain.
+```bash
+sudo certbot certonly --standalone -d <DOMAIN> -d api.<DOMAIN>
+```
+### Committing Changes
+Run the following.
+```bash
+systemctl restart nginx
+```
+
+# Updating PasteBook
+Run the following commands in succession.
+```bash
+docker compose stop
+docker compose pull
+docker compose up -d
+```
+
+# Final Notes
+Wow. There was a lot that can go wrong there. I'm not an expert. If you need help, you can email me at [email protected] or find me elsewhere.
+
+💜