Merge pull request #20 from tgpethan-alt/master

Replace all references to the old EUS url in the README
This commit is contained in:
Leah Nicole 2020-11-25 10:24:32 +00:00 committed by GitHub
commit d9f935ba35
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -22,16 +22,16 @@ Install the dependencies and then simply drop the EUS.js into a Revolution insta
## Config ## 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. 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://ethanus.ml/**. 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.ml/**.
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**. 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 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 ## API
EUS has 3 apis, they are located at **[/api/get-stats](https://ethanus.ml/api/get-stats)**, **[/api/get-info](https://ethanus.ml/api/get-info)** and **[/api/get-server-status](https://ethanus.ml/api/get-server-status)** EUS has 3 apis, they are located at **[/api/get-stats](https://eusv.ml/api/get-stats)**, **[/api/get-info](https://eusv.ml/api/get-info)** and **[/api/get-server-status](https://eusv.ml/api/get-server-status)**
[These are better documented on EUS Docs](https://docs.ethanus.ml) [These are better documented on EUS Docs](https://docs.eusv.ml)
## Websites that use EUS ## Websites that use EUS
[EUS](https://ethanus.ml) [EUS](https://eusv.ml)