98 lines
3.1 KiB
Markdown
98 lines
3.1 KiB
Markdown
# Vieter
|
|
|
|
I host documentation for Vieter over at https://rustybever.be/docs/vieter/. API
|
|
documentation for the current codebase can be found at
|
|
https://rustybever.be/api-docs/vieter/.
|
|
|
|
For more information, questions or just a chat, there's
|
|
[#vieter:rustybever.be](https://matrix.to/#/#vieter:rustybever.be) on Matrix!
|
|
|
|
## Overview
|
|
|
|
Vieter is a restart of the Pieter project. The goal is to create a simple,
|
|
lightweight self-hostable Arch repository server, paired with a system that
|
|
periodically builds & publishes select Arch packages. This would allow me to
|
|
build AUR packages (or PKGBUILDs I created myself) "in the cloud" & make sure I
|
|
never have to compile anything on my own systems, making my updates a lot
|
|
quicker.
|
|
|
|
## Why V?
|
|
|
|
I chose [V](https://vlang.io/) as I've been very intrigued by this language for
|
|
a while now. I wanted a fast language that I could code while relaxing, without
|
|
having to exert too much mental effort & V seemed like the right choice for
|
|
that. Sadly, this didn't quite turn out the way I expected, but I'm sticking
|
|
with it anyways ;p
|
|
|
|
## Features
|
|
|
|
* Arch repository server
|
|
* Support for multiple repositories & multiple architectures
|
|
* Endpoints for publishing new packages
|
|
* API for managing repositories to build
|
|
* Build system
|
|
* Periodic rebuilding of packages
|
|
* Prevent unnecessary rebuilds
|
|
|
|
## Building
|
|
|
|
Besides a V installer, Vieter also requires the following libraries to work:
|
|
|
|
* libarchive
|
|
* openssl
|
|
* sqlite3
|
|
|
|
Vieter also depends on some external V modules which you can install using `cd
|
|
src && v install`. Make sure to keep these dependencies up to date using `v
|
|
update`.
|
|
|
|
### Compiler
|
|
|
|
V is developed using a specific compiler commit that is usually updated
|
|
whenever a new version is released. Information on this can be found in the
|
|
[tools](https://git.rustybever.be/vieter-v/tools) repository.
|
|
|
|
## Contributing
|
|
|
|
If you wish to contribute to the project, please take note of the following:
|
|
|
|
* Rebase instead of merging whenever possible, e.g. when updating your branch
|
|
with the dev branch.
|
|
* Please follow the
|
|
[Conventional Commits](https://www.conventionalcommits.org/) style for your
|
|
commit messages.
|
|
|
|
### Writing documentation
|
|
|
|
The `docs` directory contains a Hugo site consisting of all user &
|
|
administrator documentation. `docs/api` on the other hand is a
|
|
[Slate](https://github.com/slatedocs/slate) project describing the HTTP web
|
|
API.
|
|
|
|
To modify the Hugo documentation, you'll need to install Hugo. Afterwards, you
|
|
can use the following commands inside the `docs` directory:
|
|
|
|
```sh
|
|
# Build the documentation
|
|
hugo
|
|
|
|
# Host an auto-refreshing web server with the documentation. Important to note
|
|
# is that the files will be at `http://localhost:1313/docs/vieter` instead of
|
|
# just `http://localhost:1313/`
|
|
hugo server
|
|
```
|
|
|
|
For the Slate docs, I personally just start a docker container:
|
|
|
|
```sh
|
|
docker run \
|
|
--rm \
|
|
-p 4567:4567 \
|
|
--name slate \
|
|
-v $(pwd)/docs/api/source:/srv/slate/source slatedocs/slate serve
|
|
```
|
|
|
|
This will make the Slate docs available at http://localhost:4567. Sadly, this
|
|
server doesn't auto-refresh, so you'll have to manually refresh your browser
|
|
every time you make a change.
|