github-starred/gerbil
2
0
Fork 0
mirror of https://github.com/fosrl/gerbil.git synced 2026-03-22 12:54:30 -05:00
Code Issues 8 Packages Projects Releases 9 Wiki Activity

config_example.json doesn't seem recent #7

New Issue
Open
opened 2025-11-19 07:03:01 -06:00 by GiteaMirror · 2 comments
GiteaMirror commented 2025-11-19 07:03:01 -06:00
Owner
Copy Link

Originally created by @DennisGaida on GitHub (Oct 20, 2025).

Describe the Bug

The https://github.com/fosrl/gerbil/blob/main/config_example.json seems to be outdated. ipAddress for example isn't referenced in the https://github.com/fosrl/gerbil/blob/main/README.md, but the CLI Args talks about an example_config.json which doesn't exist.

Environment

To Reproduce

See https://github.com/fosrl/gerbil/blob/main/config_example.json

Expected Behavior

I'd love a full config example to see all best-practices.

  • REMOTE_CONFIG says "URL of the remote config server" - Aren't we talking Pangolin here? Can we say so in the documentation, e.g. "URL of the remote config server (e.g. Pangolin)"?
  • Documentation differs between the CLI args & Environment Variables, probably should be a table with the same explanation and just listing CLI arg & env var
  • reachableAt says "How should the remote server reach Gerbil's API?" or "Endpoint of the HTTP server to tell remote config about" - Are we talking about remote servers as-in newt? Since the documentation and all examples talk about the local address (e.g. "http://gerbil:3004"), this isn't very "remote" to me. Also see above it is called the "remote config server", so I assume we are actually talking about Pangolin here and not newt.
Originally created by @DennisGaida on GitHub (Oct 20, 2025). ### Describe the Bug The https://github.com/fosrl/gerbil/blob/main/config_example.json seems to be outdated. `ipAddress` for example isn't referenced in the https://github.com/fosrl/gerbil/blob/main/README.md, but the CLI Args talks about an `example_config.json` which doesn't exist. ### Environment - ### To Reproduce See https://github.com/fosrl/gerbil/blob/main/config_example.json ### Expected Behavior I'd love a full config example to see all best-practices. - `REMOTE_CONFIG` says "URL of the remote config server" - Aren't we talking Pangolin here? Can we say so in the documentation, e.g. "URL of the remote config server (e.g. Pangolin)"? - Documentation differs between the CLI args & Environment Variables, probably should be a table with the same explanation and just listing CLI arg & env var - `reachableAt` says "How should the remote server reach Gerbil's API?" or "Endpoint of the HTTP server to tell remote config about" - Are we talking about remote servers as-in `newt`? Since the documentation and all examples talk about the local address (e.g. "http://gerbil:3004"), this isn't very "remote" to me. Also see above it is called the "remote config server", so I assume we are actually talking about Pangolin here and not newt.
GiteaMirror commented 2025-11-19 07:03:02 -06:00
Author
Owner
Copy Link

@oschwartz10612 commented on GitHub (Oct 20, 2025):

Hi Dennis! Thanks for bringing this up!

The config.json kind of predates this project a little bit. I had
visions of Gerbil being used outside of Pangolin as a simple wireguard
server and being able to use the config.json to configure the server.
Similar to wg-quick.

However I dont think this makes much sense anymore as Gerbil is very
tied in with Pangolin and really relies on it for functionality. I am
pretty tempted to just remove the json config all together.

Would love to hear if you or anyone else feels differently though!

@oschwartz10612 commented on GitHub (Oct 20, 2025): Hi Dennis! Thanks for bringing this up! The config.json kind of predates this project a little bit. I had visions of Gerbil being used outside of Pangolin as a simple wireguard server and being able to use the config.json to configure the server. Similar to wg-quick. However I dont think this makes much sense anymore as Gerbil is very tied in with Pangolin and really relies on it for functionality. I am pretty tempted to just remove the json config all together. Would love to hear if you or anyone else feels differently though!
GiteaMirror commented 2025-11-19 07:03:02 -06:00
Author
Owner
Copy Link

@DennisGaida commented on GitHub (Oct 21, 2025):

Totally understandable the link to wg-quick. I don't need the config file at all, personally I am using environment vars for everything but secrets.

I have more of an axe to grind with newt since the only way to pass in docker secrets is the CONFIG_FILE variable. I'd love to be able to just have the ID & secret via docker secrets (or files if you will) instead of the whole config file. But that's an issue for newt not gerbil ;-)

@DennisGaida commented on GitHub (Oct 21, 2025): Totally understandable the link to wg-quick. I don't need the config file at all, personally I am using environment vars for everything but secrets. I have more of an axe to grind with newt since the only way to pass in docker secrets is the `CONFIG_FILE` variable. I'd love to be able to just have the ID & secret via docker secrets (or files if you will) instead of the whole config file. But that's an issue for newt not gerbil ;-)
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
pull-request
Mirrored from GitHub Pull Request
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/gerbil#7
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?