Skip to content

Commit

Permalink
docs: add container image to installation info
Browse files Browse the repository at this point in the history
Signed-off-by: Alexander Trost <[email protected]>
  • Loading branch information
galexrt committed May 15, 2024
1 parent 0cbbd80 commit 170dd9e
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 1 deletion.
8 changes: 8 additions & 0 deletions content/1.getting-started/1.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,14 @@ title: Getting Started
* List of your colleagues with date of births and phone numbers.
* Time clock with stats for yourself and colleagues.

### Calendar

* Calendar for public, "private" and faction events.

### Qualifications

* Provide basic qualification modules with a request system to citizens.

### Livemap

* Map to see your colleagues and other factions live.
Expand Down
18 changes: 18 additions & 0 deletions content/1.getting-started/3.components.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Components
---

* Envoy Proxy
* Proxying user "API" requests (GRPC web) to the FiveNet server via GRPC.
* Message Queue / NATS
* Communication between components, user notifications and more.
* MySQL database server (from your gameserver)
* FiveNet
* Frontend
* Serves the frontend and map tiles.
* Server
* Can also host the frontend.
* Worker
* Runs some "background" tasks, e.g., dispatch center assignment, expiration, cleanup, etc.
* Discord
* Discord bot component (e.g., group and user info sync)
3 changes: 2 additions & 1 deletion content/1.getting-started/3.installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,10 @@ title: Installation
1. Download or build the FiveNet container images.
1. Checkout the [`docker-compose.yaml`](https://github.com/fivenet-app/fivenet/blob/main/docker-compose.yaml) as an example (the mysql included in it isn't needed as you would use your existing gameserver's database server).
2. To build the FiveNet container image you need to have a [Nuxt UI Pro license key](https://ui.nuxt.com/pro/pricing).
3. Container images are available from [GHCR.io fivenet-app/fivenet registry](https://github.com/fivenet-app/fivenet/pkgs/container/fivenet).
2. Prepare config file for Fivenet, check out [configuration page](./4.configuration.md).
1. Make sure to correctly set database details, public url and session/cookie domain.
3. Run the FiveNet server, worker and other components.
3. Run the FiveNet server, worker and other components either via the `docker-compose.yaml` or manually via binary.
1. For the server component you can add `--serve-frontend` to not have to run the frontend component as well.
4. Add the FiveNet server plugin to your FiveM gameserver.
1. Example code can be found [here](https://github.com/fivenet-app/fivenet/tree/main/plugins/fivem/fivenet).

0 comments on commit 170dd9e

Please sign in to comment.