From 307dba81ec1ac120a388369d014af401f132a4f9 Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Sun, 20 Sep 2026 19:10:02 +0200 Subject: [PATCH] put quickstart in readme --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 7e516d0..8cdadbe 100644 --- a/README.md +++ b/README.md @@ -13,3 +13,25 @@ php version, database server, optional s3 or ldap setup and more. Documentation for haze can be found in the [book](https://icewind.codeberg.page/haze/) + +## Quickstart + +- Grab a binary from the + [Codeberg releases](https://codeberg.org/icewind/haze/releases) and place it + in your `$PATH` + +- Create a file `~/.config/haze/haze.toml` with the following content: + + ```toml + sources_root = "/path/to/nextcloud/sources" + ``` + +- Start a basic Nextcloud instance: + + ```bash + haze start + ``` + +- Navigate to the address that is provided in the output. + +See the [book](https://icewind.codeberg.page/haze/) for more details.