37 lines
2.6 KiB
Markdown
37 lines
2.6 KiB
Markdown
<p align="center">
|
|
<img width="150" height="150" src="https://eusv.net/images/EUSLossless.webp">
|
|
</p>
|
|
<p align="center">
|
|
EUS is my public screenshot server built using <a href="https://github.com/tgpholly/Revolution">Revolution</a><br>
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://www.codefactor.io/repository/github/tgpethan/eus/overview/master"><img src="https://www.codefactor.io/repository/github/tgpholly/eus/badge/master" alt="CodeFactor" /></a>
|
|
<a src="https://discord.gg/BV8QGn6"><img src="https://img.shields.io/discord/477024246959308810?color=7289da&label=Discord&logo=discord&logoColor=ffffff"></a>
|
|
</p>
|
|
|
|
## Setup
|
|
|
|
EUS has extra dependencies other than those of [Revolution](https://github.com/tgpethan/Revolution), the server EUS is made on, of which include:
|
|
- [connect-busboy](https://www.npmjs.com/package/connect-busboy)
|
|
- [randomstring](https://www.npmjs.com/package/randomstring)
|
|
- [diskusage](https://www.npmjs.com/package/diskusage)
|
|
- [stream-meter](https://www.npmjs.com/package/stream-meter)
|
|
- [mysql](https://www.npmjs.com/package/mysql)
|
|
|
|
Simply drop the EUS.js into a Revolution instance's modules folder **(If you still have [example_request_handler.js](https://github.com/tgpethan/Revolution/blob/master/modules/example_request_handler.js) be sure to delete it!)** and the extra required modules should be automatically installed.
|
|
|
|
## Config
|
|
On first startup EUS will create a new config file in the **modules/EUS/** folder, some of these values may need to be changed depending on your use case.
|
|
|
|
The value of **baseURL** will need to be changed to what you access the server from, for example if the server's ip is 192.168.1.100 and you are not planning to use EUS at a url you would change the value to **http://192.168.1.100/**. **baseURL** is used to construct the response url for file uploads, for example the value of **baseURL** on my instance of EUS is **https://eusv.net/**.
|
|
|
|
If you want to expand the files that the server allows to be sent to it this can be done in the **allowedTypes** array. By default the array contains **png, jpg and gif**.
|
|
|
|
The value of **uploadKey** is used to restrict who can upload to your server, set this to something and the server will restrict who can upload depending on if they provided the key or not. If this field is left blank EUS will asume you don't want an upload key and uploads to it will be unrestricted
|
|
|
|
## API
|
|
EUS has 3 api endpoints, they are **[/api/get-stats](https://eusv.net/api/get-stats)**, **[/api/get-info](https://eusv.net/api/get-info)** and **[/api/get-server-status](https://eusv.net/api/get-server-status)**
|
|
|
|
## Websites that use EUS
|
|
[EUS](https://eusv.net)
|