You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 13, 2025. It is now read-only.
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
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.
0 commit comments