TrueChartsClone/charts/stable/rcon-webadmin/docs/installation.md

27 lines
1.4 KiB
Markdown
Raw Normal View History

chore(docs): lints some docs, uses front-matter instead of # h1, and fix list items in changelog (#16589) **Description** <!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. --> ⚒️ Fixes # <!--(issue)--> front matter is supported by all doc sites (including github markdown rendering and is easier to add extra metadata later on, if we want to. ``` --- title: sometitle --- ``` **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code **🧪 How Has This Been Tested?** <!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration --> **📃 Notes:** <!-- Please enter any other relevant information here --> **✔️ Checklist:** - [ ] ⚖️ My code follows the style guidelines of this project - [ ] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [ ] ⬆️ I increased versions for any altered app according to semantic versioning **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🪞 I have opened a PR on [truecharts/containers](https://github.com/truecharts/containers) adding the container to TrueCharts mirror repo. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._
2023-12-31 14:24:05 +00:00
---
title: Installation Guide
---
## Credentials
- Set `RWA USERNAME` to any username for the web interface, defaults to **admin**.
- Set `RWA PASSWORD` to a secure password for the web interface.
- Set `RWA RCON PASSWORD` to the password for the initial RCON server to control.
## Configuration
- Set `RWA ADMIN` to **true** to make the initial user a admin.
- Set `RWA ENV` to **true** to use env variables. Setting this to **false** will use all default values.
- Set `RWA_WEB_RCON` to **true** to enable web rcon _if_ supported by the game server
- Set `RWA_READ_ONLY_WIDGET_OPTIONS` to **true** to prevent the initial user changing options in the widget options tab
- Set `RWA GAME` to a game such as minecraft | rust | csgo | other.
- Set `RWA SERVER NAME` to a custom name for the initial server.
- Set `RWA RCON HOST` To the initial RCON server IP to control. Cluster URL may work, but was not tested.
- Set `RWA RCON PORT` To the port number of the initial RCON server to control.
- Set `RWA_RESTRICT_COMMANDS` to prevent the initial user user executing these commands
- Set `RWA_RESTRICT_WIDGETS` to hide this list of widgets from the initial user
## Notes
- It's assumed that all game servers or services have secure passwords for RCON, blank or no passwords at all will **NOT** work and its advisable to set a secure password for both the web interface of this chart and also the rcon service too.