From 6979d90c7f686eaaab71f21d3d1c6b3555f25258 Mon Sep 17 00:00:00 2001 From: Eric Phillips Date: Fri, 8 May 2026 22:14:31 -0600 Subject: [PATCH] added bottdev requirements --- README.md | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index eae2f95..1a8b1ca 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,15 @@ # pkgstash -## A sparse caching pacman mirror +A sparse caching pacman mirror + +## Motivation Reduces external traffic in a local network with multiple arch linux systems with minimal config. It replicates the structure of a full mirror without downloading the whole mirror. Clients add this in mirrorlist and pacman just works. -## Install +## Quick Start -### From PKGBUILD +Currently disributed as a binary. Download the PKGBUILD and pkgstash.install into and empty directory, use makepkg -i to install. See [Arch User Repository](https://wiki.archlinux.org/title/Arch_User_Repository) for more information. -Currently disributed as a binary. Download the PKGBUILD and pkgstash.install, use makepkg -i to install. See [Arch User Repository](https://wiki.archlinux.org/title/Arch_User_Repository) for more information. - -### From source - -clone the repo from repo root - - go build ./cmd/server - -Binary is called pkgstash, sample config, env and service files are in deploy/ ### Configure and Start Edit `/etc/pkgstash/pkgstash.env` and change the token to a secure one. I used openssl like so: @@ -35,6 +28,10 @@ start with the included systemd service systemctl enable --now pkgstash-refresh.timer +## Usage + +Set your pacman mirrorlist to point at your server and use pacman like Normal. Currently cache misses are not streamed to the client until the server has the whole file, workaround by turning off pacmans timeout. + ### Technical details @@ -56,4 +53,11 @@ start with the included systemd service - Notify if a build needs approval - Web admin interface +## Contributing + +clone the repo from repo root + + go build ./cmd/server + +Binary is called pkgstash, sample config, env and service files are in deploy/