Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

turtl-server: init at 2018-11-05 #50409

Closed
wants to merge 4 commits into from
Closed

turtl-server: init at 2018-11-05 #50409

wants to merge 4 commits into from
+1,132 −178

Conversation

raquelgb
Copy link
Contributor

Motivation for this change

Run your own turtlapp server. See github.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nox --run "nox-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Fits CONTRIBUTING.md.

Sorry, something went wrong.

@raquelgb
turtl-server: init at 2018-11-05

Verified

This commit was signed with the committer’s verified signature.
renovate-bot Mend Renovate
GPG key ID: 81C63AE1C224182B
Verified
Learn about vigilant mode
bb414f3
@raquelgb
Fix turtl-server meta after reading contributing guidelines
b73224d
@raquelgb raquelgb requested a review from infinisil as a code owner November 15, 2018 16:20
@GrahamcOfBorg GrahamcOfBorg added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` labels Nov 15, 2018
@GrahamcOfBorg GrahamcOfBorg added 8.has: package (new) This PR adds a new package 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10 labels Nov 15, 2018
Mic92
Mic92 reviewed Nov 15, 2018
View reviewed changes
pkgs/servers/turtl-server/default.nix Outdated
}, system ? builtins.currentSystem, nodejs ? pkgs."nodejs-8_x"}:

let
nodePackages = import ./node.nix {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you try to put this into pkgs/development/node-packages/node-packages-v8.json so we can share its dependencies with the other node packages?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sharing in the sense of only having the expression stored once.
See #44076 (comment)
for previous discussions.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done! @Mic92 please check again.
Thanks for your help! It looks much simpler now.

infinisil
infinisil requested changes Nov 16, 2018
View reviewed changes
nixos/modules/services/web-apps/turtl-server.nix
services.turtl-server = {
enable = mkEnableOption "Turtl notebook server";

statePath = mkOption {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a convention to use dataDir instead.

nixos/modules/services/web-apps/turtl-server.nix
enable = mkEnableOption "Turtl notebook server";

statePath = mkOption {
type = types.str;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

types.path

nixos/modules/services/web-apps/turtl-server.nix
listenPort = mkOption {
type = types.int;
default = 8181;
example = 8181;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use types.port and remove the example (no need to have an example that's the same as the default) or change it.

nixos/modules/services/web-apps/turtl-server.nix
default = 8181;
example = 8181;
description = ''
Port.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs better description.

nixos/modules/services/web-apps/turtl-server.nix
extraConfig = mkOption {
type = types.attrs;
default = { };
description = ''
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This option is never used

nixos/modules/services/web-apps/turtl-server.nix
'';
};

analytics= mkOption {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please make the formatting consistent: Always have spaces surrounding =

nixos/modules/services/web-apps/turtl-server.nix
email:
enabled: ${toString cfg.plugin.email}
sync:
enabled: ${toString cfg.plugin.sync}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will result in sync: enabled: 1, is that right? You can use lib.boolToString to get the strings "false" or "true"

nixos/modules/services/web-apps/turtl-server.nix
'' + lib.optionalString (cfg.listenAddress == null) ''
server:
host:
port: ${toString cfg.listenPort}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use

if (cfg.listenAddress == null) then ''
  # ...
'' else ''
  # ...
''

instead

nixos/modules/services/web-apps/turtl-server.nix
cfg = config.services.turtl-server;

turtlServerConfYAML = pkgs.writeTextFile {
name = "turtl-server-config.yaml";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use pkgs.writeText instead.

nixos/modules/services/web-apps/turtl-server.nix
};

localDatabasePassword = mkOption {
type = types.str;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Try to avoid password options if possible

@mmahut
Copy link
Member

mmahut commented Aug 10, 2019

@raquelgb any updates on this?

@stale
Copy link

stale bot commented Jun 1, 2020

Thank you for your contributions.
This has been automatically marked as stale because it has had no activity for 180 days.
If this is still important to you, we ask that you leave a comment below. Your comment can be as simple as "still important to me". This lets people see that at least one person still cares about this. Someone will have to do this at most twice a year if there is no other activity.
Here are suggestions that might help resolve this more quickly:

  1. Search for maintainers and people that previously touched the
    related code and @ mention them in a comment.
  2. Ask on the NixOS Discourse. 3. Ask on the #nixos channel on
    irc.freenode.net.

@stale stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jun 1, 2020
@Mic92
Copy link
Member

Mic92 commented Jun 1, 2020

If you are still interested in working on this, please open a new PR.

@Mic92 Mic92 closed this Jun 1, 2020
@Janik-Haag Janik-Haag added the 12. first-time contribution This PR is the author's first one; please be gentle! label Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Mic92 Mic92

@infinisil infinisil

Assignees
No one assigned
Labels
2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` 8.has: package (new) This PR adds a new package 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10 12. first-time contribution This PR is the author's first one; please be gentle!
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@raquelgb @mmahut @Mic92 @infinisil @GrahamcOfBorg @Janik-Haag