Add nixos module and (very basic, template) test #1311
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nix/modules/default/default.nix
Outdated
| default = {}; | ||
| description = '' | ||
| Environment variables passed to spacebarchat-server. | ||
| See <link xlink:href="https://docs.spacebar.chat/setup/server/configuration/env"/>. |
There was a problem hiding this comment.
I thought this was supposed to be markdown?
Comment on lines
+26
to
+30
| PORT = lib.mkOption { | ||
| type = lib.types.port; | ||
| default = 3001; | ||
| description = "Port to listen on. Used by all components, including bundle. If using bundle, all components run under the same port"; | ||
| }; |
There was a problem hiding this comment.
Honestly, you probably shouldn't be using bundle in production :)
Spacebar benefits a lot from running as separate processes.
nix/modules/default/default.nix
Outdated
Comment on lines
31
to
36
| DATABASE = lib.mkOption { | ||
| type = lib.types.str; | ||
| default = "database.db"; | ||
| example = "postgres://username:passwort@host-IP:port/databaseName"; | ||
| description = "Database connection string. Defaults to SQLite3 at project root"; | ||
| }; |
There was a problem hiding this comment.
Can we change this to a lib.types.path to avoid putting credentials in the nix store? I'd like to support this for all secrets in config aswell.
|
I should probably have given you this earlier, but here's a reference of the WIP module we've been using on non-prod servers: |
|
After confirming that a module should split the components and handle distributed setups, which this PR doesn't, I'll close this for now. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To allow for declarative configuration in the nixos module, writing to spacebar's config file is disabled when the environment variable
CONFIG_READONLYis set accordingly, which the module does. (see #1310)To use the module, the following snippet can be added to the nixos configuration, where
spacebarchat-server-flakerefers to the flake inputgithub:spacebarchat/server:Note that no automatic nginx, external database and rabbitMQ setups are provided by the module yet.