https://github.com/tricked-dev/darkvault
Darkvault is a beautiful file server written with rust & sveltekit!, it uses daisy ui for the ui and the theme can be customized
https://github.com/tricked-dev/darkvault
rust
Last synced: about 1 year ago
JSON representation
Darkvault is a beautiful file server written with rust & sveltekit!, it uses daisy ui for the ui and the theme can be customized
- Host: GitHub
- URL: https://github.com/tricked-dev/darkvault
- Owner: Tricked-dev
- License: gpl-3.0
- Created: 2022-02-08T12:34:46.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-02-11T13:16:32.000Z (about 4 years ago)
- Last Synced: 2025-01-16T10:17:15.069Z (about 1 year ago)
- Topics: rust
- Language: Rust
- Homepage:
- Size: 366 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Darkvault
Darkvault is a beautiful file server written with rust & sveltekit!, it uses daisy ui for the ui and the theme can be customized
Darkvault is written in rust and only uses around ~4MB ram on linux to serve the backend and frontend
## Getting started
Download darkvault from the [releases](https://github.com/Tricked-dev/darkvault/releases) tab
create a `darkvault.toml` file and then add the following entries
```toml
directory = "." # Directory to be hosted this can be either be a relative path or a direct path
name = "DarkVault" # How the website should be branded
theme = "dark" # Supported themes are: https://daisyui.com/docs/default-themes
port = 4004 # Port for the server to be hosted on
host = "0.0.0.0" # localhost, 0.0.0.0 or 127.0.0.1
hidedotfiles = false # Hides dotfiles aka paths that start with . or files that start with . these files/folders will not be able to be downloaded/accessed
description = """
Example download list for darkvault this website is used for previews
""" # Description this will be put in the meta when javascript is loaded
urls = [
{ to = "https://github.com/Tricked-dev/darkvault", name = "Github", icon = "GithubIcon" },
] # All compatible icons can be found here https://vue-feather-icons.egoist.sh/
```
Then just run darkvault from the directory the darkvault.toml file is and a http server should start!
## Screenshots
| Light | dark |
| :---------------------- | :---------------------- |
|  |  |
## Contributing
Any contributions are welcome
### TODO
- Add torrenting