From 562398f82603fb5e2c1286cc8eef0908c4eecfdd Mon Sep 17 00:00:00 2001 From: Leo Vasanko Date: Thu, 14 Aug 2025 10:52:39 -0700 Subject: [PATCH] README cleanup --- README.md | 24 +++++++++--------------- 1 file changed, 9 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 016facd..6f8815d 100644 --- a/README.md +++ b/README.md @@ -16,22 +16,10 @@ Experience Cista by visiting [Cista Demo](https://drop.zi.fi) for a test run and ## Getting Started -### Installation - -We recommend using [UV](https://docs.astral.sh/uv/getting-started/installation/) to install the package and run it: - -```fish -uvx cista -``` - -Alternatively, you can install with `pip` or `uv pip`. This enables using the `cista` command directly without `uvx` or `uv run`. - -```fish -pip install cista --break-system-packages -``` - ### Running the Server +We recommend using [UV](https://docs.astral.sh/uv/getting-started/installation/) to install the package and run it easily: + Create an account: (or run a public server without authentication) ```fish uvx cista --user yourname --privileged @@ -42,11 +30,17 @@ Serve your files at http://localhost:8000: uvx cista -l :8000 /path/to/files ``` +Alternatively, you can install with `pip` or `uv pip`. This enables using the `cista` command directly without `uvx` or `uv run`. + +```fish +pip install cista --break-system-packages +``` + The server remembers its settings in the config folder (default `~/.local/share/cista/`), including the listen port and directory, for future runs without arguments. ### Internet Access -Most admins instead find the [Caddy](https://caddyserver.com/) web server convenient for its auto TLS certificates and all. A proxy also allows running multiple web services or Cista instances on the same IP address but different (sub)domains. +Most admins find the [Caddy](https://caddyserver.com/) web server convenient for its auto TLS certificates and all. A proxy also allows running multiple web services or Cista instances on the same IP address but different (sub)domains. `/etc/caddy/Caddyfile`: