Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Components/Iglu Controller.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ sidebar_position: 1
[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/iglu-sh/controller)

## Introduction
The **Iglu Controller** is the heart of the Iglu Project. It is a GUI to create, modify and delete [Iglu Caches](/docs/Components/Iglu%20Cache). In addition you can configure build jobs to automatically spin up [Iglu Builders](/docs/Components/Iglu%20Builder) and build [nix derivations](https://nix.dev/manual/nix/2.25/language/derivations). Those derivations will be pushed to a [cachix](https://www.cachix.org/) client compatible cache, like our [Iglu Cache](/docs/Components/Iglu%20Cache).
The **Iglu Controller** is the heart of the Iglu Project. It is a GUI to create, modify and delete [Iglu Caches](/docs/Components/Iglu%20Cache). In addition, you can configure build jobs to automatically spin up [Iglu Builders](/docs/Components/Iglu%20Builder) and build [nix derivations](https://nix.dev/manual/nix/2.25/language/derivations). Those derivations will be pushed to a [cachix](https://www.cachix.org/) client compatible cache, like our [Iglu Cache](/docs/Components/Iglu%20Cache).
2 changes: 1 addition & 1 deletion docs/Getting started/Install with Docker compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 2
---

We recommend the installation via docker compose, as it is the simplest way.
We recommend the installation via docker compose, as it is the simplest one.

## Compose file

Expand Down
11 changes: 5 additions & 6 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,24 @@ sidebar_position: 1
# Introducing Iglu

## What is Iglu?
**Iglu** is an easy to use cache for nix derivations. So that you don't have to build your derivations (packages, configurations, ...) multipletimes.
**Iglu** is an easy-to-use cache for nix derivations and binaries. It allows you to avoid rebuilding your derivations (packages, configurations, etc.) multiple times.
You can use the official [cachix](https://hackage.haskell.org/package/cachix) client to push derivations to your own Iglu cache.

## Why Iglu?
Iglu was build to improve the usability of nix caches for normal users and organisations. We tested much caches, like
Iglu was build to improve the usability of nix caches for normal users and organisations. We tested several existing solutions, but they didn't fit our requirements. Here are some of the existing solutions we tested:

- [attic](https://github.com/zhaofengli/attic/)
- [cachix](https://www.cachix.org/)
- [cache-server](https://github.com/mifka01/cache-server)
- [nix-serve](https://github.com/edolstra/nix-serve)

Sadly, all of these didn't fit our requirements for a stable, multi-tenant implemenation that could be used with the cachix client.
So we ([SirBerg](https://github.com/SirBerg) and [Svenum](https://github.com/Svenum)) decided to build our own cache!
We want to provide these features:

- A simple UI to manage all caches
- A stable and userfriendly experience
- A way to build and upload derivations easyliy and automated by a builtin [builder](https://github.com/iglu-sh/builder)
- An easy-to-use and easy-to-maintain codebase for either forking or colaboration
- A stable and user-friendly experience
- A way to build and upload derivations easily and automated by a builtin [builder](https://github.com/iglu-sh/builder)
- An easy-to-use and easy-to-maintain codebase for either forking or collaboration

## Comparison
Here are some comparison to other caches:
Expand Down