> For the complete documentation index, see [llms.txt](https://nexeum.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://nexeum.gitbook.io/docs/dutylogs/installation.md).

# Installation Guide

In order for dutylogs to work, [nex-duty](https://nexeum-studios.tebex.io/package/6794438) is required to be installed and setup in your server. This is a standalone resource that we created, but doubles up as the integration resource between your server and dutylogs. Once you have nex-duty setup, the installation process for dutylogs is very simple. 

In `config/server_config.lua:`

1. Set the `Server_Config.State` value to `hosted`
2. Insert your servers Private API Key into `Server_Config.API_KEY`

As of right now, the site utilises the `image_url` value in each entities configuration in `Config.Entities` in the `config/shared_config.lua`. You must include a `.png` image url for each entity, otherwise the entity (department) images on dutylogs will be blank.

If you want to use the Live Map feature, in `config/shared_config.lua:`

1. Set the `Config.LiveMap` value to `true`
2. If you only want on-duty units to have access to the live map, set the `Config.RestrictLiveMap` value to true

Once you've completed those steps, restart the resource and the script will connect to dutylogs.