diff --git a/README.md b/README.md index 9b15fd1..82f9439 100755 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # anssxustawai A Not Shitty ShareX Upload Server That Actually Works As Intended (Pronounced "an-zoo-sta-why") +This project is still very young, so don't expect *everything* to be perfect yet. + ## Features - [x] Token authorization via HTTP `Authorization` header @@ -12,14 +14,19 @@ A Not Shitty ShareX Upload Server That Actually Works As Intended (Pronounced "a ## Installation +The installation may look daunting but it's really pretty straightforward. Just follow it word-for-word & you'll be fine. If you are not fine, then by all means [open an Issue](https://github.com/tycrek/anssxustawai/issues/new) & I'll try my best to help. + 1. First of all you must have Node.js 14 or later installed. It might work with Node.js 12 but just use 14. 2. Clone this repo using `git clone https://github.com/tycrek/anssxustawai.git && cd anssxustawai/` 3. Install the required dependencies using `npm i` -4. Configure `.env.example` *before* running if you wish to +4. Configure `.env.example` *before* running if you wish to. This will let you configure your port number & domain name. 5. Run `npm start` to start. This will: - Automatically copy `.env.example` to `.env` - Creates `data.json` & `auth.json` - Generates your first authorization token & saves it to `auth.json` +6. You must also configure an SSL-enabled reverse proxy: + - I personally use Caddy, see [my tutorial](https://jmoore.dev/tutorials/2021/03/caddy-express-reverse-proxy/) on setting that up + - You may also Apache or Nginx as reverse proxies ## Configure ShareX @@ -37,4 +44,9 @@ A Not Shitty ShareX Upload Server That Actually Works As Intended (Pronounced "a 5. **Response** tab: - URL: `$json:.resource$` - Deletion URL: `$json:.delete$` -6. The file `sample_config.sxcu` can also be modified and imported to suit your needs +6. The file `sample_config.sxcu` can also be modified & imported to suit your needs + +## Known issues + +- **Videos won't embed on Discord**: I know. This is because Discord developers make some really stupid decisions & only show embeds if the URL ends with `.mp4`. So the workaround: manually type "`.mp4`" after pasting your URL. This will be fixed automatically in the future with some ZWS redirect tricks. +- **It won't work over HTTP**: Yes because HTTP is outdated crap, why are you still using it??