updated README and TODO

This commit is contained in:
2026-05-29 10:05:54 -06:00
parent 0aa5fbb6c5
commit 9e073f9a5c
3 changed files with 9 additions and 11 deletions
+5 -8
View File
@@ -30,21 +30,18 @@ start with the included systemd service
## 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.
Set your pacman mirrorlist to point at your server and use pacman like Normal. Update mirror urls, mirrored repos in /etc/pkgstash/pkgstash.toml to suit your needs.
### Technical details
1. Go as the language. It has most of the tools necessary for a http server ins the standard library and it's performant.
2. Singleflight to prevent 2 clients from causing the server to fetch the same package more than once.
1. Go as the language. It has most of the tools necessary for a http server ins the standard library and it's performant
2. Initial usage streams downloads to multiple clients concurrently from one upstream request
3. Pkgs are written atomically to prevent serving partial files
4. Use multiple mirrors for redundancy and spread the load out.
5. Refresh the remote db files on a schedule to enable prefetching of cached pkgs.
4. Use multiple mirrors for redundancy and spread the load out
5. Sync the cache on a schedule, includes refreshing databases, prefetching cached pkgs, and cleaning out old pkgs
### Roadmap
- Prefetch and cache cleanup
- Streaming on cache misses
- cli admin tool
- Custom repo
- Build server
+2 -2
View File
@@ -1,5 +1,3 @@
- More complete sync(refresh packages on schedule with db, prefetch updates to pkgs we already have)
- clean cache of old files
- Deployment
- automated changelog publishing
- ci check golangci-lint docs
@@ -11,6 +9,8 @@
- Build server/tool
- Think about: arch doesn't like partial upgrades, round robin fetching the db files might be an issue
- Add chi for mux
- ~clean cache of old files~
- ~More complete sync(refresh packages on schedule with db, prefetch updates to pkgs we already have)~
- ~implement streaming~
- ~implementation~
- ~refactor cache tests to match new interface using testify~
+2 -1
View File
@@ -17,7 +17,8 @@ import (
type mockCache struct {
fetched []string
fetchDBCalled bool
clean error
//nolint:unused // required for interface
clean error
}
func (m *mockCache) FetchDB(repo string) error {