Skip to content
This repository was archived by the owner on Apr 13, 2025. It is now read-only.

Commit 00079d8

Browse files
committed
Add documentation for automatic login
Explains how automatic login (codeoverflow-org/nodecg-io#241) can be configured. Also reformats `docs/stylesheets/colors.css`. This was done automatically by prettier from the code repository
1 parent 814d2dd commit 00079d8

File tree

3 files changed

+45
-3
lines changed

3 files changed

+45
-3
lines changed

docs/getting_started/configuration.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Configuration
2+
3+
<!-- TODO: introduction sentence -->
4+
5+
The configuration file for nodecg-io is at `cfg/nodecg-io-core.json` inside your nodecg installation. This file does not exist by default, you need to create it yourself.
6+
7+
The currently only thing you can configure is automatic login, but there may be more configurable options in the future.
8+
9+
## Automatic login
10+
11+
Automatic login will automatically load nodecg-io when nodecg starts using the provided password.
12+
13+
Therefore nodecg-io will be able to decrypt your configuration for your service instances and provide your bundles with service clients without you logging in to nodecg-io using the dashboard.
14+
This is especially useful if you are running nodecg with nodecg-io on a server which may reboot from time to time to ensure that your bundles are always working without you needing to manually login after each restart.
15+
16+
**Security warning:** Having both the encrypted configuration and your used password saved on disk defeats nodecg-ios data-at-rest encryption.
17+
Any program that can read disk contents can access your credentials of any service instance. We discourage using this and if you really want to use it you should be extra cautious about which bundles you install.
18+
19+
Options of automatic login:
20+
21+
- `enabled` (boolean)
22+
23+
Automatic login will be only enabled if this `enabled` option is set to `true`.
24+
This option can be used to temporarily disable automatic login without needing to delete the whole automatic login configuration
25+
and allows for easy re-enabling without needing to enter the password in the config again.
26+
27+
- `password` (string)
28+
29+
This is the password that will be used to login. It should be the password you use to login to nodecg-io.
30+
If this password is wrong a error will be logged after startup.
31+
32+
Example config:
33+
34+
```json
35+
{
36+
"automaticLogin": {
37+
"enabled": true,
38+
"password": "ThisIsMyPassword.PleaseChangeMe"
39+
}
40+
}
41+
```

docs/stylesheets/colors.css

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:root {
2-
--md-primary-fg-color: #5836FF;
3-
--md-accent-fg-color: #DD241F;
2+
--md-primary-fg-color: #5836ff;
3+
--md-accent-fg-color: #dd241f;
44
--md-header-color--dark: #2c1849;
55
}
66

@@ -13,7 +13,7 @@
1313
}
1414

1515
.md-nav__source {
16-
--md-primary-fg-color--dark: #1F1135;
16+
--md-primary-fg-color--dark: #1f1135;
1717
}
1818

1919
.md-typeset .task-list-control [type="checkbox"]:checked + .task-list-indicator::before {

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ nav:
3838
- Getting Started:
3939
- Installation: getting_started/install.md
4040
- Your first bundle: getting_started/create_bundle.md
41+
- Configuration: getting_started/configuration.md
4142
- Contribute:
4243
- Basics: contribute/contribute.md
4344
- Create a Service: contribute/create_service.md

0 commit comments

Comments
 (0)