docs: update readme

This commit is contained in:
2025-12-29 08:56:43 +01:00
parent 10fd579d0b
commit 48f2b8448a

View File

@@ -10,33 +10,36 @@
## Installation ## Installation
### Classic
Run the installation script: Run the installation script:
```sh ```sh
scripts/install.sh scripts/install.sh
``` ```
Enable and start the systemd service: It will create a `urupam` user and group, deploy the application in `/opt/urupam` and create/enable a `systemd` service. Documentation will be installed in `/usr/share/doc/urupam`.
```sh The application will listen on `:8080`.
sudo systemctl enable --now urupam
```
### Using docker ### Using docker
Build the image and use the `docker-compose` file: Build the image and use the `docker-compose` file:
```sh ```sh
cd docker
docker build -t urupam . docker build -t urupam .
docker compose up -d docker compose up -d
``` ```
Alternatively, if you already have a running `redis` instance, you can skip `compose` and start a standalone container:
```sh
docker run --name urupam -p 8080:8080 -d urupam:latest
```
## Hacking ## Hacking
To run the application in development, you'll first need a Redis server. To run the application in development, you'll first need a Redis server. The easiest way is to start one is using Docker:
The easiest way is to start a local Redis instance using Docker:
```sh ```sh
docker run --name mojo-redis -p 6379:6379 -d redis docker run --name mojo-redis -p 6379:6379 -d redis