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.

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

nixos/crproxy: init module crproxy #356098

Open
wants to merge 16 commits into
base: master
Choose a base branch
from
Open

nixos/crproxy: init module crproxy #356098

wants to merge 16 commits into from

Conversation

senseab
Copy link

@senseab senseab commented Nov 15, 2024

a generic image proxy for dockerhub, see https://github.com/DaoCloud/crproxy/releases/tag/v0.12.2

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 25.05 Release Notes (or backporting 24.11 and 25.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

@github-actions github-actions bot 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/` 8.has: maintainer-list (update) This PR changes `maintainers/maintainer-list.nix` labels Nov 15, 2024
@NixOSInfra NixOSInfra added the 12. first-time contribution This PR is the author's first one; please be gentle! label Nov 15, 2024
@ofborg ofborg bot added 8.has: package (new) This PR adds a new package 11.by: package-maintainer This PR was created by the maintainer of the package it changes 10.rebuild-darwin: 1-10 10.rebuild-darwin: 1 10.rebuild-linux: 1-10 labels Nov 15, 2024
@h7x4 h7x4 added the 8.has: module (new) This PR adds a module in `nixos/` label Nov 17, 2024
nixos/modules/services/networking/crproxy.nix Outdated Show resolved Hide resolved
nixos/modules/services/networking/crproxy.nix Outdated Show resolved Hide resolved
nixos/modules/services/networking/crproxy.nix Outdated Show resolved Hide resolved
nixos/modules/services/networking/crproxy.nix Outdated Show resolved Hide resolved
nixos/modules/services/networking/crproxy.nix Outdated Show resolved Hide resolved
nixos/modules/services/networking/crproxy.nix Outdated Show resolved Hide resolved
pkgs/by-name/cr/crproxy/package.nix Outdated Show resolved Hide resolved
pkgs/by-name/cr/crproxy/package.nix Outdated Show resolved Hide resolved
pkgs/by-name/cr/crproxy/package.nix Outdated Show resolved Hide resolved
pkgs/by-name/cr/crproxy/package.nix Outdated Show resolved Hide resolved
privilegedIPList = mkOption {
default = [ ];
type = types.listOf types.str;
description = "privileged IP list";
Copy link
Member

Choose a reason for hiding this comment

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

What is a "privileged IP" here? Please add that info to the description.

Copy link
Author

@senseab senseab Jan 2, 2025

Choose a reason for hiding this comment

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

I have updated the code, see the latest version

simpleAuthUser = mkOption {
type = types.listOf types.str;
default = [ ];
description = "simple auth user and password (default [])";
Copy link
Member

Choose a reason for hiding this comment

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

Please add an example showing how to use this.

nixos/modules/services/networking/crproxy.nix Outdated Show resolved Hide resolved
true
'';
type = types.bool;
description = "Behind the reverse proxy, such as nginx";
Copy link
Member

Choose a reason for hiding this comment

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

What effect does this option have?

Copy link
Author

Choose a reason for hiding this comment

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

This option is enabled when the crproxy is fronted by nginx, allowing it to receive HTTP headers from nginx and ensuring that the crproxy can function properly.

pkgs/by-name/cr/crproxy/package.nix Outdated Show resolved Hide resolved
pkgs/by-name/cr/crproxy/package.nix Outdated Show resolved Hide resolved
nixos/modules/services/networking/crproxy.nix Outdated Show resolved Hide resolved
senseab and others added 2 commits January 2, 2025 08:25
@senseab senseab requested a review from FliegendeWurst January 2, 2025 00:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: maintainer-list (update) This PR changes `maintainers/maintainer-list.nix` 8.has: module (new) This PR adds a module in `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: 1-10 10.rebuild-linux: 1-10 11.by: package-maintainer This PR was created by the maintainer of the package it changes 12. first-time contribution This PR is the author's first one; please be gentle!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants