Skip to content

Latest commit

 

History

History
90 lines (56 loc) · 3.06 KB

README.md

File metadata and controls

90 lines (56 loc) · 3.06 KB
Raw

Puck 🏒

Puck (Package Update Checking Kit yes I know it sucks) is a simple tool that connects to your servers and checks for apt package updates.

Screenshot

Warning ⚠️: Puck is in early stages of development it still has a lot of missing features I want to add. I hope I can have a stable release soon.

Features 😲

Well about that...

  • Tiny CLI (only 10mb)
  • Beautiful CLI
  • Really fast*

Puck itself is really fast since it's written in GO but the actual speed depends on the server

Supported Target Operating Systems

Currently puck supports these operating systems/package managers:

  • Ubuntu (apt)
  • Debian (apt)
  • Fedora (dnf)
  • Open Suse (dnf)
  • Alpine (apk)
  • Arch (pacman) why would you run arch in a server 🤨

Todo 📃

  • Redesign the CLI UI
  • Docker Image
  • Web UI
  • Discord notifications
  • Ntfy notifications
  • Ability not to use sudo (for systems running with root)
  • Support for other package managers (currently only supporting apt)

Running 🏃

Puck is built for multiple architectures and systems and you can simply download it and run it from the release page, thats it!

Building 🛠️

You can build puck very easily by installing go and git on your pc and then simply running:

go build .

The build is really fast and when it finished you should have a binary called puck in your current directory.

Note 📝: If you like so you can build the app for different architectures using this command GOOS=windows GOARCH=amd64 go build . which will create puck.exe for windows amd64. While I am not actively testing this on other architectures it should work just fine.

Usage

To begin with you need a configuration file, check out the wiki on how to create your configuration file.

Running with binary 🗑️

After you make your configuration file you can run puck using this command:

./puck check

Puck be default will look for puck.yml but if you wish to use a different file name you can use the -c or --config flag to specify a custom path, this is also the same for the docker image.

Running with docker 🐋

If you prefer docker you can run puck using this command:

docker run -t --rm --name=puck -v /some/path/puck.yml:/puck.yml:ro ghcr.io/steveiliop56/puck

Contributing ❤️

Contributing is really easy in puck you simply need to have go and git in your system, then you can clone the repository make your changes and open a pull request. Any help is appreciated.

License 📜

The project is licensed under the GPL V3 License. You may modify, distribute and copy the code as long as you keep the changes in the source files. Any modifications you make using a compiler must be also licensed under the GPL license and include build and install instructions.

Acknowledgments 🙏

  • The project is heavily inspired from cup.
  • Carbon thanks for the screenshot