CLI simplification, better diagnostic for missing wwwroot, docs.

This commit is contained in:
Leo Vasanko 2023-11-14 08:03:15 -08:00
parent 1fdd00b833
commit c40c245ce6
5 changed files with 63 additions and 27 deletions

View File

@ -1,16 +1,14 @@
# Cista Web Storage # Cista Web Storage
<img src="https://git.zi.fi/Vasanko/cista-storage/raw/branch/main/docs/cista.jpg" align=right width=250>
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 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. 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.
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.
Experience Cista by visiting [Cista Demo](https://drop.zi.fi) for a test run and perhaps upload something... 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: To install the cista application, use:
```sh ```fish
pip install cista pip install cista
``` ```
@ -28,13 +26,13 @@ Note: Some Linux distributions might need `--break-system-packages` to install P
### Running the Server ### Running the Server
Create an account: Create an account: (or run a public server without authentication)
```sh ```fish
cista --user yourname --privileged cista --user yourname --privileged
``` ```
Serve your files at http://localhost:8000: Serve your files at http://localhost:8000:
```sh ```fish
cista -l :8000 /path/to/files 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: To use your own TLS certificates, place them in the config folder and run:
```sh ```fish
cista -l cista.example.com 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 ```Caddyfile
cista.example.com { 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. 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 cd frontend
npm install npm install
npm run dev npm run dev
@ -68,7 +66,7 @@ npm run dev
Concurrently, start the backend on another terminal: Concurrently, start the backend on another terminal:
```sh ```fish
hatch shell hatch shell
pip install -e '.[dev]' pip install -e '.[dev]'
cista --dev -l :8000 /path/to/files cista --dev -l :8000 /path/to/files
@ -101,7 +99,7 @@ WantedBy=multi-user.target
This setup supports multiple storages, each under `/media/storage/<domain>` for files and `/srv/cista/<domain>/` for configuration. UNIX sockets are used instead of numeric ports for convenience. This setup supports multiple storages, each under `/media/storage/<domain>` for files and `/srv/cista/<domain>/` for configuration. UNIX sockets are used instead of numeric ports for convenience.
```sh ```fish
systemctl daemon-reload systemctl daemon-reload
systemctl enable --now cista@foo.example.com systemctl enable --now cista@foo.example.com
systemctl enable --now cista@bar.example.com systemctl enable --now cista@bar.example.com

View File

@ -62,12 +62,15 @@ def _main():
_confdir(args) _confdir(args)
exists = config.conffile.exists() exists = config.conffile.exists()
import_droppy = args["--import-droppy"] 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: if not necessary_opts:
# Maybe run without arguments # Maybe run without arguments
print(doc) print(doc)
print( 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 return 1
settings = {} settings = {}
@ -79,8 +82,15 @@ def _main():
settings = droppy.readconf() settings = droppy.readconf()
if path: if path:
settings["path"] = path settings["path"] = path
elif not exists:
settings["path"] = Path.home() / "Downloads"
if listen: if listen:
settings["listen"] = 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) operation = config.update_config(settings)
print(f"Config {operation}: {config.conffile}") print(f"Config {operation}: {config.conffile}")
# Prepare to serve # Prepare to serve
@ -112,11 +122,23 @@ def _confdir(args):
def _user(args): def _user(args):
_confdir(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"] name = args["--user"]
if not name or not name.isidentifier(): if not name or not name.isidentifier():
raise ValueError("Invalid username") raise ValueError("Invalid username")
config.load_config()
u = config.config.users.get(name) u = config.config.users.get(name)
info = f"User {name}" if u else f"New user {name}" info = f"User {name}" if u else f"New user {name}"
changes = {} changes = {}
@ -128,12 +150,17 @@ def _user(args):
info += " (admin)" if oldadmin else "" info += " (admin)" if oldadmin else ""
if args["--password"] or not u: if args["--password"] or not u:
changes["password"] = pw = pwgen.generate() changes["password"] = pw = pwgen.generate()
info += f"\n Password: {pw}" info += f"\n Password: {pw}\n"
res = config.update_user(args["--user"], changes) res = config.update_user(name, changes)
print(info) print(info)
if res == "read": if res == "read":
print(" No changes") print(" No changes")
if operation == "created":
print(
"Now you can run the server:\n cista # defaults set: -l :8000 ~/Downloads\n"
)
if __name__ == "__main__": if __name__ == "__main__":
sys.exit(main()) sys.exit(main())

View File

@ -119,9 +119,20 @@ def _load_wwwroot(www):
if len(br) >= len(data): if len(br) >= len(data):
br = False br = False
wwwnew[name] = data, br, headers wwwnew[name] = data, br, headers
if not wwwnew and not app.debug: if not wwwnew:
logging.warning( msg = f"Web frontend missing from {base}\n Did you forget: hatch build\n"
f"Web frontend missing from {base}\n Did you forget: hatch build" 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 return wwwnew

View File

@ -138,7 +138,7 @@ def update_user(conf: Config, name: str, changes: dict) -> Config:
# Encode into dict, update values with new, convert to Config # Encode into dict, update values with new, convert to Config
try: try:
u = conf.users[name].__copy__() u = conf.users[name].__copy__()
except KeyError: except (KeyError, AttributeError):
u = User() u = User()
if "password" in changes: if "password" in changes:
from . import auth from . import auth
@ -147,7 +147,7 @@ def update_user(conf: Config, name: str, changes: dict) -> Config:
del changes["password"] del changes["password"]
udict = msgspec.to_builtins(u, enc_hook=enc_hook) udict = msgspec.to_builtins(u, enc_hook=enc_hook)
udict.update(changes) 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) settings["users"][name] = msgspec.convert(udict, User, dec_hook=dec_hook)
return msgspec.convert(settings, Config, dec_hook=dec_hook) return msgspec.convert(settings, Config, dec_hook=dec_hook)

BIN
docs/cista.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB