Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/machengim/oasis
Self-hosted file server
https://github.com/machengim/oasis
Last synced: 2 months ago
JSON representation
Self-hosted file server
- Host: GitHub
- URL: https://github.com/machengim/oasis
- Owner: machengim
- License: mit
- Created: 2021-05-02T04:22:26.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-28T01:22:24.000Z (almost 2 years ago)
- Last Synced: 2024-08-01T12:28:58.985Z (6 months ago)
- Language: Svelte
- Homepage:
- Size: 26.6 MB
- Stars: 330
- Watchers: 4
- Forks: 16
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-MIT
Awesome Lists containing this project
- awesome-homelab - OASIS - hosted file server | (Apps / FileSharing)
README
## OASIS
[![Build](https://github.com/machengim/oasis/actions/workflows/build_release.yml/badge.svg)](https://github.com/machengim/oasis/actions/workflows/build_release.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/machengim/oasis/blob/main/LICENSE-MIT) [![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/machengim/oasis)](https://github.com/machengim/oasis/releases) [![Docker](https://img.shields.io/badge/docker-v0.2.6-orange)](https://hub.docker.com/r/machengim/oasis)
[中文 README](https://github.com/machengim/oasis/blob/main/README_cn.md)
A self-hosted file server.
![](https://github.com/machengim/oasis/blob/main/doc/demo.png?raw=true)
### Install
1. Download from the [release](https://github.com/machengim/oasis/releases) page
2. Uncompress
3. Grant execute permission to `oasis` file if running in Linux or MacOS
4. (Optional) Config server IP and port number in `oasis.conf` file
5. Run `oasis` or `oasis.exe`
6. Visit the server's IP address in your favorite browser### Docker
https://hub.docker.com/r/machengim/oasis
```
docker run --name oasis -t -d \
-v :/opt/oasis/data \
-v :/home/storage \
-p :8000 machengim/oasis
```### Build
- Node 14+
- Rust 1.54+```
cd path/to/oasis
node build.js
```### Features
- User authentication
- File preview/download/upload/Search
- Media file play list
- File external link
- I18n (English, Chinese)### File format support
- Text
- Image (browser support)
- Audio (browser support)
- Video (browser support)
- Subtitle (`srt` / `vtt` format, supported in Chrome, Firefox and Edge by now)
- PDF (supported by pdf.js)### Tech stack
- [Svelte](https://svelte.dev)
- [Rocket](https://rocket.rs)
- [Tailwind](https://tailwindcss.com)### Credits
- [Pdf.js](https://mozilla.github.io/pdf.js)
- [Plyr](https://plyr.io)