Skip to content

Commit

Permalink
Add documentation for distro packaging
Browse files Browse the repository at this point in the history
  • Loading branch information
mbuesch committed Jan 5, 2025
1 parent c40199f commit ddf15e7
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,11 @@ The main design goals of letmein are:

For more information about security and reporting vulnerabilities, please see the [security documentation](SECURITY.md) of letmein.


# Distribution packaging

If you want to package the software for distribution, please see the [distribution packaging hints](doc/DISTRO_PACKAGING.md).

# License

Copyright (c) 2024-2025 Michael Büsch <m@bues.ch>
Expand Down
13 changes: 13 additions & 0 deletions doc/DISTRO_PACKAGING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Recommendations for distribution packaging

If you want to package the software for distribution, a few adjustments/patches are recommended:

- If you install default configuration files, you might want to adjust `[NFTABLES] exe = ...` to the absolute path of your `nft` binary. See [the configuration documentation](CONFIGURATION.md#exe) for more details.

- You probably want to install the systemd units under `/lib/systemd/system/` or similar, instead of `/etc`.

- The build environment variable `LETMEIN_CONF_PREFIX` sets the prefix for the configuration files.
In a plain `cargo build` this will default to `/` meaning that `/etc/letmein{,d}.conf` will be the place for the configuration files.
If you use the `build.sh` script, the prefix will be set to `/opt/letmein` instead

- Adjust the install prefix from `/opt` to something else that makes more sense for your distribution.

0 comments on commit ddf15e7

Please sign in to comment.