Vasanko/cista-storage
Vasanko/cista-storage
2
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

README cleanup

Browse Source
This commit is contained in:
Leo Vasanko 2025-08-14 10:52:39 -07:00
parent 54b5c80e31
commit 562398f826
1 changed files with 9 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -16,22 +16,10 @@ Experience Cista by visiting [Cista Demo](https://drop.zi.fi) for a test run and
## Getting Started ## 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 ### 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) Create an account: (or run a public server without authentication)
```fish ```fish
uvx cista --user yourname --privileged uvx cista --user yourname --privileged
@ -42,11 +30,17 @@ Serve your files at http://localhost:8000:
uvx cista -l :8000 /path/to/files 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. 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 ### 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`: `/etc/caddy/Caddyfile`: