mirror of https://github.com/AlphaNecron/Void.git
chore: added LICENSE and readme
This commit is contained in:
parent
935e550dfa
commit
64e8305747
|
@ -0,0 +1,21 @@
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2021 AlphaNecron
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
|
@ -0,0 +1,63 @@
|
||||||
|
<div align="center">
|
||||||
|
<img src="https://raw.githubusercontent.com/AlphaNecron/Draconic/v0/public/banner.png"/>
|
||||||
|
A self-hosted file hosting service based on Zipline with many features.
|
||||||
|
|
||||||
|
![Build stable](https://img.shields.io/github/workflow/status/AlphaNecron/Draconic/CI:%20Build/v0?color=%2368D391&label=stable&logo=github&style=for-the-badge)
|
||||||
|
![Build stable](https://img.shields.io/github/workflow/status/AlphaNecron/Draconic/CI:%20Build/dev?color=%2368D391&label=dev&logo=github&style=for-the-badge)
|
||||||
|
![Stars](https://img.shields.io/github/stars/AlphaNecron/Draconic?color=%23B794F4&logo=github&style=for-the-badge)
|
||||||
|
![Version](https://img.shields.io/github/package-json/v/AlphaNecron/Draconic/v0?color=%23B794F4&label=latest&logo=react&logoColor=ffffff&style=for-the-badge)
|
||||||
|
![Last commit](https://img.shields.io/github/last-commit/AlphaNecron/Draconic/dev?color=%234FD1C5&logo=github&style=for-the-badge)
|
||||||
|
</div>
|
||||||
|
|
||||||
|
### Requirements
|
||||||
|
- `node` >= 16
|
||||||
|
- PostgreSQL
|
||||||
|
- Either `yarn` or `npm`
|
||||||
|
|
||||||
|
### Installation / Deployment
|
||||||
|
```sh
|
||||||
|
git clone https://github.com/AlphaNecron/Draconic.git
|
||||||
|
cd Draconic
|
||||||
|
yarn install # or npm install
|
||||||
|
cp config.example.toml config.toml
|
||||||
|
nano config.toml # edit the config file
|
||||||
|
yarn build # or npm build
|
||||||
|
yarn start # or npm start
|
||||||
|
```
|
||||||
|
|
||||||
|
### Reverse proxy (nginx)
|
||||||
|
```nginx
|
||||||
|
server {
|
||||||
|
listen 443 ssl;
|
||||||
|
server_name your.domain;
|
||||||
|
ssl_certificate /path/to/cert;
|
||||||
|
ssl_certificate_key /path/to/key;
|
||||||
|
ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
|
||||||
|
ssl_ciphers HIGH:!aNULL:!MD5;
|
||||||
|
client_max_body_size 128M;
|
||||||
|
location / {
|
||||||
|
proxy_pass http://localhost:3000;
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
proxy_set_header X-Real-IP $remote_addr;
|
||||||
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
|
proxy_set_header X-Forwarded-Proto $scheme;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Features
|
||||||
|
- Configurable
|
||||||
|
- Super fast
|
||||||
|
- Built with Next.js & React
|
||||||
|
- Token protected uploading
|
||||||
|
- Easy to setup
|
||||||
|
- Invisible URL
|
||||||
|
- Emoji URL
|
||||||
|
|
||||||
|
### Todo
|
||||||
|
- AWS S3 support
|
||||||
|
- Docker support
|
||||||
|
- URL shortener
|
||||||
|
- Better gallery
|
||||||
|
- Discord bot
|
||||||
|
- Discord integration
|
Loading…
Reference in New Issue