From 13d36be6430067ac47f0a330fecd0533c0919430 Mon Sep 17 00:00:00 2001 From: Imbus <> Date: Mon, 12 Feb 2024 17:54:10 +0100 Subject: [PATCH] Restructured build --- BUILD.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/BUILD.md b/BUILD.md index a3903c3..e5a686f 100644 --- a/BUILD.md +++ b/BUILD.md @@ -47,6 +47,14 @@ To **build** the frontend, resulting in a static bundle, you need to navigate to The release build for the backend is a simple binary that can be run on any machine. The release build for the frontend is a static bundle that can be served by any web server. +There are two ways to deploy the release build: as a standalone binary or as a container. The drawbacks of using a standalone binary is that it requires fiddling with the static files as well as matching it with a database on the host system. The drawbacks of using a container is that it requires Podman/Docker. The container is the recommended way to deploy the release build, and doing it this way, we can also deploy the database in a container. + +### Container Deployment + We combine the frontend and backend into a single container using Podman/Docker. The `Containerfile` (also known as a Dockerfile) in the container directory is used to build the container. To see exactly how the container is built, refer to the `Containerfile`. To build and reploy a release container with Podman, issue the `just start-release` command anywhere in the project directory. This will build the container and run it on `localhost:8080`. The container will be running in the background, and you can manage it with Podman see the podman documentation for more information. + +### Standalone Binary Deployment + +UNDER CONSTRUCTION