dasbaumwolltier/simple-repository-manager

A simple, lightweight repository manager written in rust

Simple Repository Manager

A very simple, lightweight repository manager written in rust.

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Docker
   • Building
   • Prerequisites
   • Installation
3. Configuration
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This project was started becasue I wanted something like Nexus OSS to host my Archlinux repository. I, however, wanted something lightweight, as it should not eat resources doing nothing most of the time.

As such I first implemented a raw FileRepository, which can just GET and PUT arbitrary files inside the repository, storing them on disk.

(back to top)

Built With

• Rust
• Rocket
• Serde
• Other Packages: See Cargo.toml

(back to top)

Getting Started

There are two ways to use the server:

1. Docker
2. Build it yourself

Docker

For this to work you have to have a working docker installation and a config.yaml (see Configuration) file. The you can run the docker container with:

docker run -p 8000:8000 -v $(realpath config.yaml):/config.yaml dasbaumwolltier/simple-repository-manager:0.1.4

Building

Prerequisites

This software is built with rust, so you need an up to date stable rust installation. For this consult the examples below or your favourite search engine.

• Archlinux

sudo pacman -S rustup
rustup toolchain install stable

• Other Linux Distros (with curl installed)

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
rustup toolchain install stable

Installation

You can build a binary from the repository by first cloning the repository, then running:

cargo build --release

After which you will find the binary under target/release/simple-repository-manager. This binary the can be run like so for example target/release/simple-repository-manager --config config.yaml.

Configuration

The server is configured using a config.yaml file, of which all options are documented thoroughly in the template-config.yaml.

The only command line options available are:

• -c | --config: The path of the config.yaml file
• -h | --host (optional): The host the server should listen on
• -p | --port (optional): The port the server should listen on
• -v | --verbose (optional, repeatable): Changes the log level from Info to Debug and Trace with 1 and 2 occurrences respectively

(back to top)

Roadmap

• Cache Header
  • ETag/Last Modified
• Retention Policy
  • Add deleteFile method to provider
  • Add DELETE Endpoint
• Refactor authentication
  • Move authentication out of Repository and leave authorization in Repository
  • Create AuthenticationProvider
  • (Add more sophisticated user management)
• Documentation
• Add more providers
  • ...

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have suggestions that would make the project better, please open an issue with the tag "enhancement". If you want to implement it, please also first open an issue to discuss.
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

This work is licensed the Apache License 2.0. See LICENSE for more information.

(back to top)

Contact

Gabriel Guldner - @dasbaumwolltier - [email protected]

Project Link: https://github.com/dasbaumwolltier/simple-repository-manager

(back to top)

Acknowledgments

• Best-README-Template

(back to top)