-
-
Notifications
You must be signed in to change notification settings - Fork 12.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'upstream/master' into HEAD
- Loading branch information
Showing
270 changed files
with
1,295 additions
and
450 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
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
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,205 @@ | ||
| { lib, pkgs, config, ... } : | ||
|
|
||
| with lib; | ||
|
|
||
| let | ||
| cfg = config.services.postage; | ||
|
|
||
| confFile = pkgs.writeTextFile { | ||
| name = "postage.conf"; | ||
| text = '' | ||
| connection_file = ${postageConnectionsFile} | ||
| allow_custom_connections = ${builtins.toJSON cfg.allowCustomConnections} | ||
| postage_port = ${toString cfg.port} | ||
| super_only = ${builtins.toJSON cfg.superOnly} | ||
| ${optionalString (!isNull cfg.loginGroup) "login_group = ${cfg.loginGroup}"} | ||
| login_timeout = ${toString cfg.loginTimeout} | ||
| web_root = ${cfg.package}/etc/postage/web_root | ||
| data_root = ${cfg.dataRoot} | ||
| ${optionalString (!isNull cfg.tls) '' | ||
| tls_cert = ${cfg.tls.cert} | ||
| tls_key = ${cfg.tls.key} | ||
| ''} | ||
| log_level = ${cfg.logLevel} | ||
| ''; | ||
| }; | ||
|
|
||
| postageConnectionsFile = pkgs.writeTextFile { | ||
| name = "postage-connections.conf"; | ||
| text = concatStringsSep "\n" | ||
| (mapAttrsToList (name : conn : "${name}: ${conn}") cfg.connections); | ||
| }; | ||
|
|
||
| postage = "postage"; | ||
| in { | ||
|
|
||
| options.services.postage = { | ||
| enable = mkEnableOption "PostgreSQL Administration for the web"; | ||
|
|
||
| package = mkOption { | ||
| type = types.package; | ||
| default = pkgs.postage; | ||
| defaultText = "pkgs.postage"; | ||
| description = '' | ||
| The postage package to use. | ||
| ''; | ||
| }; | ||
|
|
||
| connections = mkOption { | ||
| type = types.attrsOf types.str; | ||
| default = {}; | ||
| example = { | ||
| "nuc-server" = "hostaddr=192.168.0.100 port=5432 dbname=postgres"; | ||
| "mini-server" = "hostaddr=127.0.0.1 port=5432 dbname=postgres sslmode=require"; | ||
| }; | ||
| description = '' | ||
| Postage requires at least one PostgreSQL server be defined. | ||
| </para><para> | ||
| Detailed information about PostgreSQL connection strings is available at: | ||
| <link xlink:href="http://www.postgresql.org/docs/current/static/libpq-connect.html"/> | ||
| </para><para> | ||
| Note that you should not specify your user name or password. That | ||
| information will be entered on the login screen. If you specify a | ||
| username or password, it will be removed by Postage before attempting to | ||
| connect to a database. | ||
| ''; | ||
| }; | ||
|
|
||
| allowCustomConnections = mkOption { | ||
| type = types.bool; | ||
| default = false; | ||
| description = '' | ||
| This tells Postage whether or not to allow anyone to use a custom | ||
| connection from the login screen. | ||
| ''; | ||
| }; | ||
|
|
||
| port = mkOption { | ||
| type = types.int; | ||
| default = 8080; | ||
| description = '' | ||
| This tells Postage what port to listen on for browser requests. | ||
| ''; | ||
| }; | ||
|
|
||
| localOnly = mkOption { | ||
| type = types.bool; | ||
| default = true; | ||
| description = '' | ||
| This tells Postage whether or not to set the listening socket to local | ||
| addresses only. | ||
| ''; | ||
| }; | ||
|
|
||
| superOnly = mkOption { | ||
| type = types.bool; | ||
| default = true; | ||
| description = '' | ||
| This tells Postage whether or not to only allow super users to | ||
| login. The recommended value is true and will restrict users who are not | ||
| super users from logging in to any PostgreSQL instance through | ||
| Postage. Note that a connection will be made to PostgreSQL in order to | ||
| test if the user is a superuser. | ||
| ''; | ||
| }; | ||
|
|
||
| loginGroup = mkOption { | ||
| type = types.nullOr types.str; | ||
| default = null; | ||
| description = '' | ||
| This tells Postage to only allow users in a certain PostgreSQL group to | ||
| login to Postage. Note that a connection will be made to PostgreSQL in | ||
| order to test if the user is a member of the login group. | ||
| ''; | ||
| }; | ||
|
|
||
| loginTimeout = mkOption { | ||
| type = types.int; | ||
| default = 3600; | ||
| description = '' | ||
| Number of seconds of inactivity before user is automatically logged | ||
| out. | ||
| ''; | ||
| }; | ||
|
|
||
| dataRoot = mkOption { | ||
| type = types.str; | ||
| default = "/var/lib/postage"; | ||
| description = '' | ||
| This tells Postage where to put the SQL file history. All tabs are saved | ||
| to this location so that if you get disconnected from Postage you | ||
| don't lose your work. | ||
| ''; | ||
| }; | ||
|
|
||
| tls = mkOption { | ||
| type = types.nullOr (types.submodule { | ||
| options = { | ||
| cert = mkOption { | ||
| type = types.str; | ||
| description = "TLS certificate"; | ||
| }; | ||
| key = mkOption { | ||
| type = types.str; | ||
| description = "TLS key"; | ||
| }; | ||
| }; | ||
| }); | ||
| default = null; | ||
| description = '' | ||
| These options tell Postage where the TLS Certificate and Key files | ||
| reside. If you use these options then you'll only be able to access | ||
| Postage through a secure TLS connection. These options are only | ||
| necessary if you wish to connect directly to Postage using a secure TLS | ||
| connection. As an alternative, you can set up Postage in a reverse proxy | ||
| configuration. This allows your web server to terminate the secure | ||
| connection and pass on the request to Postage. You can find help to set | ||
| up this configuration in: | ||
| <link xlink:href="https://github.com/workflowproducts/postage/blob/master/INSTALL_NGINX.md"/> | ||
| ''; | ||
| }; | ||
|
|
||
| logLevel = mkOption { | ||
| type = types.enum ["error" "warn" "notice" "info"]; | ||
| default = "error"; | ||
| description = '' | ||
| Verbosity of logs | ||
| ''; | ||
| }; | ||
| }; | ||
|
|
||
| config = mkIf cfg.enable { | ||
| systemd.services.postage = { | ||
| description = "postage - PostgreSQL Administration for the web"; | ||
| wants = [ "postgresql.service" ]; | ||
| after = [ "postgresql.service" ]; | ||
| wantedBy = [ "multi-user.target" ]; | ||
| serviceConfig = { | ||
| User = postage; | ||
| Group = postage; | ||
| ExecStart = "${pkgs.postage}/sbin/postage -c ${confFile}" + | ||
| optionalString cfg.localOnly " --local-only=true"; | ||
| }; | ||
| }; | ||
| users = { | ||
| users."${postage}" = { | ||
| name = postage; | ||
| group = postage; | ||
| home = cfg.dataRoot; | ||
| createHome = true; | ||
| }; | ||
| groups."${postage}" = { | ||
| name = postage; | ||
| }; | ||
| }; | ||
| }; | ||
| } |
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
Oops, something went wrong.