Skip to content

Add documentation, startup scripts and command line support for MUD configurable miss#105

Open
haqa wants to merge 21 commits into
angt:masterfrom
haqa:master
Open

Add documentation, startup scripts and command line support for MUD configurable miss#105
haqa wants to merge 21 commits into
angt:masterfrom
haqa:master

Conversation

@haqa

@haqa haqa commented Apr 3, 2026

Copy link
Copy Markdown
  • Document Glorytun usage
  • Add enhanced system startup scripts for SystemD and OpenRC with documentation
  • Add support for variable BEAT MISS (implemented in MUD) per path

This, along with angt/mud#10 , now provides reliable, in-order, delivery, and faster path response to individual effective path up/down, and startup scripts/config that supports this.

Adrian Hungate and others added 21 commits March 24, 2026 09:56
This commit introduces a comprehensive command-line reference for Glorytun, detailing available commands, options, and usage examples. The new documentation covers commands such as `bind`, `show`, `set`, and `path`, providing clear instructions for users to manage tunnels effectively.
This commit introduces a new markdown file detailing the setup of a multipath tunnel using Glorytun between two machines. It includes network topology, prerequisites, step-by-step instructions for generating a shared key, starting the tunnel, configuring source-based policy routing, and adding paths for each interface. This comprehensive guide aims to assist users in effectively utilizing Glorytun for enhanced bandwidth and failover capabilities.
… in Glorytun

This commit introduces a new markdown file detailing the current behavior of Glorytun's traffic scheduling, a proposed Plan B for separating scheduling weights from rate caps, and a summary of future options. The document aims to provide a comprehensive understanding of the scheduling mechanisms and design considerations for enhanced performance.
This commit introduces the necessary scripts and configuration files for running Glorytun as both a client and server under OpenRC and systemd. The new files include init scripts, configuration files, and README documentation for installation and usage. These additions aim to facilitate the deployment and management of Glorytun tunnels, enhancing user experience and operational efficiency.
This commit deletes the glorytun-run and glorytun-setup scripts from the systemd directory, streamlining the service management for Glorytun. These scripts are replaced by the multi-type, multi-system startup scripts under /scripts
This commit updates the command-line reference documentation, enhancing clarity and consistency in the usage of commands. Key changes include the introduction of nested argument syntax for `bind` and `path` commands, updates to example commands, and improved descriptions for options. Additionally, the multipath example documentation is revised to reflect these changes, ensuring users have accurate guidance for configuring Glorytun tunnels effectively.
This update introduces the HEARTBEAT_MISS parameter, allowing users to specify the maximum number of heartbeats without a reply before a path is considered degraded. The new option is reflected in the glorytun-client scripts and documentation, enhancing path management capabilities. Additionally, the .gitignore file is updated to exclude .nfs files, and the mud submodule is updated to the latest commit.
…flow triggers

This commit modifies the version command in meson.build to strip any trailing whitespace and updates the GitHub Actions workflow to trigger on pull requests and manual dispatch, in addition to push events. These changes improve version handling and CI/CD flexibility.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant