Blob README.md
-rw-r--r-- 3.4 KiB

🌄 Ayllu

Ayllu is a hyper performant & hackable code forge optimized for single instance deployments. It leverages the distributed nature of Git with a variety of standards based integrations.

Project Status & Collaboration

Please note that this project is both a work in progress and a labor of love (sometimes) by a single developer and as such contributions can be challenging to adopt since the project is changing rapidly. Small fixes and updates are appreciated and typically easy to merge but larger changes will likely require coordination.

To facilitate collaboration we have mirrors available at codeberg and sourcehut. Please feel free to use which ever platform you prefer, eventually we will import both platforms into Ayllu.

Tickets

Patches

Chat

A general development channel #ayllu is available on Libera and on Matrix.

LLM / AI Policy

LLM / AI contributions are explicitly forbidden, each line of code you contribute should be written by you OR generated by some kind of deterministic tooling. If you read the output of something that may have been generated by an LLM and it looks like what you want to do that’s okay but adapt the concept in your own language and accommodate the local idioms of this project.

Code of Conduct

We do not currently have a code of conduct however if/when the need arises to adopt one it will be one which is characterized by inclusivity and empathy.

Documentation

The majority of Ayllu’s documentation is hosted in the man page section on it’s canonical site: ayllu-forge.org/man, if you already have Ayllu installed then try man ayllu.7.

Installation

Although Ayllu uses container technologies and can itself be containerized it is best installed on a virtual machine or physical server. Originally Ayllu shipped with a container environment but it was awkward to maintain so it was removed, as the project stabilizes we can add one back again.

Ayllu’s internal CI system distributes packages for both Debian and ArchLinux systems. It is discouraged to consume from these because we want to encourage upstream support for Ayllu by the various distributions. Our internal packages can also serve as a reference for packagers. See scripts/build_deb.sh and the PKGBUILD in the root of the Ayllu repository. To find recent compiled packages for Debian / Arch check for recent builds here

Compiling From Source

Ayllu is written in rust and you’ll need its compiler to build the project.

You can run the check_build_dependencies.sh script to verify you have all the necessary software on your system.

Minimum Rust Version

Ayllu targets whatever version of Rust is available in debian-testing.

# check your build dependencies
scripts/check_build_dependencies.sh
# intialize the sqlite database
scripts/ensure_database.sh
# build the project
cargo build