diff --git a/README.md b/README.md index eddcfa1..1edbfe7 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,14 @@ # Cista Web Storage + + Cista takes its name from the ancient cistae, metal containers used by Greeks and Egyptians to safeguard valuable items. This modern application provides a browser interface for secure and accessible file storage, echoing the trust and reliability of its historical namesake. -Cista Storage is a cutting-edge file and document server designed for speed, efficiency, and unparalleled ease of use. Experience lightning-fast browsing, thanks to the file list maintained directly in your browser and updated from server filesystem events, coupled with our highly optimized code. +This is a cutting-edge **file and document server** designed for speed, efficiency, and unparalleled ease of use. Experience **lightning-fast browsing**, thanks to the file list maintained directly in your browser and updated from server filesystem events, coupled with our highly optimized code. Fully **keyboard-navigable** and with a responsive layout, Cista flawlessly adapts to your devices, providing a seamless experience wherever you are. Our powerful **instant search** means you're always just a few keystrokes away from finding exactly what you need. Press **1/2/3** to switch ordering, navigate with all four arrow keys (+Shift to select). Or click your way around on **breadcrumbs that remember where you were**. -Fully keyboard-navigable and with a responsive layout, Cista Storage flawlessly adapts to your devices, providing a seamless experience wherever you are. +The Cista project started as an inevitable remake of [Droppy](https://github.com/droppyjs/droppy) which we used and loved despite its numerous bugs. Cista Storage stands out in handling even the most exotic filenames, ensuring a smooth experience where others falter. -Our powerful instant search means you're always just a few keystrokes away from finding exactly what you need. Press 1/2/3 to switch ordering, navigate with all four arrow keys, or by clicking on breadcrumbs that remember where you were. - -The Cista project started as an inevitable remake of [Droppy](https://github.com/droppyjs/droppy) which we used and loved despite its numerous bugs. Cista Storage stands out in handling even the most unconventional filenames, ensuring a smooth experience where others falter. - -All of this is wrapped in an intuitive interface, making Cista Storage the ideal choice for anyone seeking a reliable, versatile, and quick file storage solution. Join us at Cista Storage – where your files are just a click away, safe, and always accessible. +All of this is wrapped in an intuitive interface with automatic light and dark themes, making Cista Storage the ideal choice for anyone seeking a reliable, versatile, and quick file storage solution. Quickly setup your own Cista where your files are just a click away, safe, and always accessible. Experience Cista by visiting [Cista Demo](https://drop.zi.fi) for a test run and perhaps upload something... @@ -20,7 +18,7 @@ Experience Cista by visiting [Cista Demo](https://drop.zi.fi) for a test run and To install the cista application, use: -```sh +```fish pip install cista ``` @@ -28,13 +26,13 @@ Note: Some Linux distributions might need `--break-system-packages` to install P ### Running the Server -Create an account: -```sh +Create an account: (or run a public server without authentication) +```fish cista --user yourname --privileged ``` Serve your files at http://localhost:8000: -```sh +```fish cista -l :8000 /path/to/files ``` @@ -44,11 +42,11 @@ The server remembers its settings in the config folder (default `~/.local/share/ To use your own TLS certificates, place them in the config folder and run: -```sh +```fish cista -l cista.example.com ``` -Most admins instead find the Caddy 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. Caddy configuration **/etc/caddy/Caddyfile** is dead simple: +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. Caddy configuration **/etc/caddy/Caddyfile** is dead simple: ```Caddyfile cista.example.com { @@ -60,7 +58,7 @@ cista.example.com { For rapid development, we use the Vite development server for the Vue frontend, while running the backend on port 8000 that Vite proxies backend requests to. Each server live reloads whenever its code or configuration are modified. -```sh +```fish cd frontend npm install npm run dev @@ -68,7 +66,7 @@ npm run dev Concurrently, start the backend on another terminal: -```sh +```fish hatch shell pip install -e '.[dev]' cista --dev -l :8000 /path/to/files @@ -101,7 +99,7 @@ WantedBy=multi-user.target This setup supports multiple storages, each under `/media/storage/` for files and `/srv/cista//` for configuration. UNIX sockets are used instead of numeric ports for convenience. -```sh +```fish systemctl daemon-reload systemctl enable --now cista@foo.example.com systemctl enable --now cista@bar.example.com diff --git a/cista/__main__.py b/cista/__main__.py index 04d143d..407c60f 100644 --- a/cista/__main__.py +++ b/cista/__main__.py @@ -62,12 +62,15 @@ def _main(): _confdir(args) exists = config.conffile.exists() import_droppy = args["--import-droppy"] - necessary_opts = exists or import_droppy or path and listen + necessary_opts = exists or import_droppy or path if not necessary_opts: # Maybe run without arguments print(doc) print( - "No config file found! Get started with:\n cista -l :8000 /path/to/files, or\n cista -l example.com --import-droppy # Uses Droppy files\n", + "No config file found! Get started with one of:\n" + " cista --user yourname --privileged\n" + " cista --import-droppy\n" + " cista -l :8000 /path/to/files\n" ) return 1 settings = {} @@ -79,8 +82,15 @@ def _main(): settings = droppy.readconf() if path: settings["path"] = path + elif not exists: + settings["path"] = Path.home() / "Downloads" if listen: settings["listen"] = listen + elif not exists: + settings["listen"] = ":8000" + if not exists and not import_droppy: + # We have no users, so make it public + settings["public"] = True operation = config.update_config(settings) print(f"Config {operation}: {config.conffile}") # Prepare to serve @@ -112,11 +122,23 @@ def _confdir(args): def _user(args): _confdir(args) - config.load_config() + if config.conffile.exists(): + config.load_config() + operation = False + else: + # Defaults for new config when user is created + operation = config.update_config( + { + "listen": ":8000", + "path": Path.home() / "Downloads", + "public": False, + } + ) + print(f"Config {operation}: {config.conffile}\n") + name = args["--user"] if not name or not name.isidentifier(): raise ValueError("Invalid username") - config.load_config() u = config.config.users.get(name) info = f"User {name}" if u else f"New user {name}" changes = {} @@ -128,12 +150,17 @@ def _user(args): info += " (admin)" if oldadmin else "" if args["--password"] or not u: changes["password"] = pw = pwgen.generate() - info += f"\n Password: {pw}" - res = config.update_user(args["--user"], changes) + info += f"\n Password: {pw}\n" + res = config.update_user(name, changes) print(info) if res == "read": print(" No changes") + if operation == "created": + print( + "Now you can run the server:\n cista # defaults set: -l :8000 ~/Downloads\n" + ) + if __name__ == "__main__": sys.exit(main()) diff --git a/cista/app.py b/cista/app.py index b82eccf..ef0534a 100644 --- a/cista/app.py +++ b/cista/app.py @@ -119,9 +119,20 @@ def _load_wwwroot(www): if len(br) >= len(data): br = False wwwnew[name] = data, br, headers - if not wwwnew and not app.debug: - logging.warning( - f"Web frontend missing from {base}\n Did you forget: hatch build" + if not wwwnew: + msg = f"Web frontend missing from {base}\n Did you forget: hatch build\n" + if not www: + logging.warning(msg) + if not app.debug: + msg = "Web frontend missing. Cista installation is broken.\n" + wwwnew[""] = ( + msg.encode(), + False, + { + "etag": "error", + "content-type": "text/plain", + "cache-control": "no-store", + }, ) return wwwnew diff --git a/cista/config.py b/cista/config.py index 7dac18c..3ecf9af 100644 --- a/cista/config.py +++ b/cista/config.py @@ -138,7 +138,7 @@ def update_user(conf: Config, name: str, changes: dict) -> Config: # Encode into dict, update values with new, convert to Config try: u = conf.users[name].__copy__() - except KeyError: + except (KeyError, AttributeError): u = User() if "password" in changes: from . import auth @@ -147,7 +147,7 @@ def update_user(conf: Config, name: str, changes: dict) -> Config: del changes["password"] udict = msgspec.to_builtins(u, enc_hook=enc_hook) udict.update(changes) - settings = msgspec.to_builtins(conf, enc_hook=enc_hook) + settings = msgspec.to_builtins(conf, enc_hook=enc_hook) if conf else {"users": {}} settings["users"][name] = msgspec.convert(udict, User, dec_hook=dec_hook) return msgspec.convert(settings, Config, dec_hook=dec_hook) diff --git a/docs/cista.jpg b/docs/cista.jpg new file mode 100644 index 0000000..28c09bd Binary files /dev/null and b/docs/cista.jpg differ