-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
We learnt a bunch of arcane commands: `sudo nixos-container create <name> --flake .#<nixosConfiguration-name>` -> creates the container `sudo nixos-container destroy <name>` -> destroys the containr `sudo nixos-container update <name> --flake .#<nixosConfiguration-name>` -> if the container already exists, recreate it using this `sudo nixos-container start <name>` `sudo nixos-container show-ip <name>` `curl http://<ip>` -> you should get nginx default page Co-authored-by: Jason Odoom <[email protected]> Co-authored-by: Anish Lakhwara <[email protected]> Co-authored-by: Dominic Mills <[email protected]> Co-authored-by: Albert Chae <[email protected]> Co-authored-by: Jack Leightcap <[email protected]> Signed-off-by: Jack Leightcap <[email protected]>
- Loading branch information
5 people
committed
Sep 15, 2023
1 parent
8788d97
commit ffcbd5e
Showing
6 changed files
with
257 additions
and
28 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| { | ||
| boot.isContainer = true; | ||
| networking.hostName = "test-flarum"; | ||
|
|
||
| # Allow nginx through the firewall | ||
| networking.firewall.allowedTCPPorts = [80]; | ||
|
|
||
| services.nginx.enable = true; | ||
| nixpkgs.hostPlatform = "x86_64-linux"; | ||
| services.flarum = { | ||
| enable = true; | ||
| domain = "10.233.2.2"; | ||
| }; | ||
| } |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,217 @@ | ||
| { | ||
| config, | ||
| lib, | ||
| pkgs, | ||
| self, | ||
| utils, | ||
| ... | ||
| }: | ||
| with builtins; | ||
| with lib; let | ||
| cfg = config.services.flarum; | ||
| opt = options.services.flarum; | ||
|
|
||
| flarumInstallConfig = pkgs.writeText "config.json" (builtins.toJSON { | ||
| debug = false; | ||
| offline = false; | ||
|
|
||
| baseUrl = cfg.baseUrl; | ||
| databaseConfiguration = cfg.database; | ||
| adminUser = { | ||
| username = cfg.adminUser; | ||
| password = cfg.initialAdminPassword; | ||
| email = cfg.adminEmail; | ||
| }; | ||
| settings = {forum_title = cfg.forumTitle;}; | ||
| }); | ||
| in { | ||
| options = { | ||
| services.flarum = with types; { | ||
| enable = mkEnableOption "Flarum discussion platform"; | ||
|
|
||
| package = mkPackageOption pkgs "flarum" {}; | ||
|
|
||
| forumTitle = mkOption { | ||
| type = types.str; | ||
| default = "A Flarum Forum on NixOS"; | ||
| description = "Title of the forum."; | ||
| }; | ||
|
|
||
| domain = mkOption { | ||
| type = types.str; | ||
| default = "localhost"; | ||
| example = "forum.example.com"; | ||
| description = "Domain to serve on."; | ||
| }; | ||
|
|
||
| baseUrl = mkOption { | ||
| type = types.str; | ||
| default = "https://${cfg.domain}"; | ||
| example = "https://forum.example.com"; | ||
| description = "Change `domain` instead."; | ||
| }; | ||
|
|
||
| adminUser = mkOption { | ||
| type = types.str; | ||
| default = "flarum"; | ||
| description = "Username for first web application administrator"; | ||
| }; | ||
|
|
||
| adminEmail = mkOption { | ||
| type = types.str; | ||
| default = "[email protected]"; | ||
| description = "Email for first web application administrator"; | ||
| }; | ||
|
|
||
| initialAdminPassword = mkOption { | ||
| type = types.str; | ||
| default = "flarum"; | ||
| description = "Initial password for the adminUser"; | ||
| }; | ||
|
|
||
| user = mkOption { | ||
| type = types.str; | ||
| default = "flarum"; | ||
| description = "System user to run Flarum"; | ||
| }; | ||
|
|
||
| group = mkOption { | ||
| type = types.str; | ||
| default = "flarum"; | ||
| description = "System group to run Flarum"; | ||
| }; | ||
|
|
||
| stateDir = mkOption { | ||
| type = types.path; | ||
| default = "/var/lib/flarum"; | ||
| description = "Home directory for writable storage"; | ||
| }; | ||
|
|
||
| database = mkOption rec { | ||
| type = with types; attrsOf (oneOf [str bool int]); | ||
| description = "MySQL database parameters"; | ||
| default = { | ||
| # the database driver; i.e. MySQL; MariaDB... | ||
| driver = "mysql"; | ||
| # the host of the connection; localhost in most cases unless using an external service | ||
| host = "localhost"; | ||
| # the name of the database in the instance | ||
| database = "flarum"; | ||
| # database username | ||
| username = "flarum"; | ||
| # database password | ||
| password = ""; | ||
| # the prefix for the tables; useful if you are sharing the same database with another service | ||
| prefix = ""; | ||
| # the port of the connection; defaults to 3306 with MySQL | ||
| port = 3306; | ||
| strict = false; | ||
| }; | ||
| }; | ||
|
|
||
| createDatabaseLocally = mkOption { | ||
| type = types.bool; | ||
| default = true; | ||
| description = "Create the database and database user locally, and run installation."; | ||
| }; | ||
| }; | ||
| }; | ||
|
|
||
| config = mkIf cfg.enable { | ||
| users.users.${cfg.user} = { | ||
| isSystemUser = true; | ||
| home = cfg.stateDir; | ||
| createHome = true; | ||
| group = cfg.group; | ||
| }; | ||
| users.groups.${cfg.group} = {}; | ||
|
|
||
| services.phpfpm.pools.flarum = { | ||
| user = cfg.user; | ||
| settings = { | ||
| "listen.owner" = config.services.nginx.user; | ||
| "listen.group" = config.services.nginx.group; | ||
| "listen.mode" = "0600"; | ||
| "pm" = mkDefault "dynamic"; | ||
| "pm.max_children" = mkDefault 10; | ||
| "pm.max_requests" = mkDefault 500; | ||
| "pm.start_servers" = mkDefault 2; | ||
| "pm.min_spare_servers" = mkDefault 1; | ||
| "pm.max_spare_servers" = mkDefault 3; | ||
| }; | ||
| phpOptions = '' | ||
| error_log = syslog | ||
| log_errors = on | ||
| ''; | ||
| }; | ||
|
|
||
| services.nginx = { | ||
| enable = true; | ||
| virtualHosts."${cfg.domain}" = { | ||
| root = "${cfg.stateDir}/public"; | ||
| locations."~ \.php$".extraConfig = '' | ||
| fastcgi_pass unix:${config.services.phpfpm.pools.flarum.socket}; | ||
| fastcgi_index site.php; | ||
| ''; | ||
| extraConfig = '' | ||
| index index.php | ||
| include ${cfg.package}/build/.nginx.conf; | ||
| ''; | ||
| }; | ||
| }; | ||
|
|
||
| services.mysql = mkIf cfg.enable { | ||
| enable = true; | ||
| package = pkgs.mysql; | ||
| ensureDatabases = [cfg.database.database]; | ||
| ensureUsers = [ | ||
| { | ||
| name = cfg.database.username; | ||
| ensurePermissions = { | ||
| "${cfg.database.database}.*" = "ALL PRIVILEGES"; | ||
| }; | ||
| } | ||
| ]; | ||
| }; | ||
|
|
||
| assertions = [ | ||
| { | ||
| assertion = !cfg.createDatabaseLocally || cfg.database.driver == "mysql"; | ||
| message = "Flarum can only be automatically installed in MySQL/MariaDB."; | ||
| } | ||
| ]; | ||
|
|
||
| systemd.services.flarum-install = { | ||
| description = "Flarum installation"; | ||
| requiredBy = ["phpfpm-flarum.service"]; | ||
| before = ["phpfpm-flarum.service"]; | ||
| requires = ["mysql.service"]; | ||
| after = ["mysql.service"]; | ||
| serviceConfig = { | ||
| Type = "oneshot"; | ||
| User = cfg.user; | ||
| Group = cfg.group; | ||
| }; | ||
| path = [config.services.phpfpm.phpPackage]; | ||
| script = | ||
| '' | ||
| mkdir -p ${cfg.stateDir}/{extensions,public/assets/avatars} | ||
| mkdir -p ${cfg.stateDir}/storage/{formatter,sessions,views} | ||
| cd ${cfg.stateDir} | ||
| cp -f ${cfg.package}/build/{extend.php,site.php,flarum} . | ||
| ln -sf ${cfg.package}/build/vendor . | ||
| ln -sf ${cfg.package}/build/public/index.php public/ | ||
| chmod a+x . public | ||
| chmod +x site.php extend.php flarum | ||
| '' | ||
| + lib.optionalString | ||
| (cfg.createDatabaseLocally && cfg.database.driver == "mysql") '' | ||
| if [ ! -f config.php ]; then | ||
| php flarum install --file=${flarumInstallConfig} | ||
| fi | ||
| php flarum migrate | ||
| # php flarum cache:clear | ||
| ''; | ||
| }; | ||
| }; | ||
| } |