The simple self-hosted ShareX server
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
tycrek de61d73c1e
added random colour for embeds
4 years ago
generators improved token generator 4 years ago
.gitignore added setup script 4 years ago
LICENSE mode 4 years ago
README.md added list of access types to header purpose 4 years ago
ass.js added custom embeds via http headers 4 years ago
ogp.js added random colour for embeds 4 years ago
package-lock.json added luxon for saving upload timestamp 4 years ago
package.json added luxon for saving upload timestamp 4 years ago
sample_config.sxcu rebranded to "ass" 4 years ago
setup.js minor fixes 4 years ago
utils.js added random colour for embeds 4 years ago

README.md

ass

GitHub package.json version GitHub license GitHub last commit Lines of code GitHub Repo stars

ass is a self-hosted ShareX upload server written in Node.js. I initially started this project purely out of spite.

Features

  • ✔️ Token authorization via HTTP Authorization header
  • ✔️ Upload images, videos, files
  • ✔️ Seamless inline video embeds on Discord
  • ✔️ Delete support
  • ✔️ Multiple access types
    • ZWS
    • Mixed-case alphanumeric
    • Original
  • Thumbnail support
  • Multiple database types
    • JSON
    • Mongo (soon!)
    • MySQL (soon!)
    • PostgreSQL (soon!)
  • Multi-user support (upload restrictions, web library, etc.)
  • Block-storage support including Amazon S3
  • Usage metrics

Access types

Type What is it?
ZWS (Zero-width spaces) The "fancy" mode. When pasted elsewhere, the URL appears to be just your domain name. ZWS sample
Mixed-case alphanumeric The "safe" mode. URL's are browser safe as the character set is just letters & numbers.
Original The "basic" mode. URL matches the same filename as when the file was uploaded. This may be prone to conflicts with files of the same name.

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 & 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/ass.git && cd ass/
  3. Run npm i to install the required dependencies
  4. Run npm run setup to start the easy configuration
  5. Run npm start to start the server. The first time you run it you will be shown your first authorization token; save this as you will need it to configure ShareX.
  6. (Optional) You must also configure an SSL-enabled reverse proxy (only if you want to use HTTPS):
    • I personally use Caddy, see my tutorial on setting that up
    • You may also use Apache or Nginx as reverse proxies

Generating new tokens

If you need to generate a new token at any time, run npm run new-token. This will automatically load the new token so there is no need to restart ass.

Cloudflare users

In your Cloudflare DNS dashboard, make sure your domain/subdomain is set to DNS Only.

Configure ShareX

  1. Add a new Custom Uploader in ShareX by going to Destinations > Custom uploader settings...
  2. Under Uploaders, click New & name it whatever you like.
  3. Set Destination type to Image, Text, & File
  4. Request tab:
    • Method: POST
    • URL: https://your.domain.name.here/
    • Body: Form data (multipart/form-data)
    • File from name: file (literally put "file" in the field)
    • Headers:
      • Name: Authorization
      • Value: (the value provided by npm start on first run)
  5. Response tab:
    • URL: $json:.resource$
    • Deletion URL: $json:.delete$
  6. The file sample_config.sxcu can also be modified & imported to suit your needs

Header overrides

If you need to override a specific part of the config to be different from the global config, you may do so via "X" HTTP headers:

Header Purpose
X-Ass-Domain Override the domain returned for the clipboard
X-Ass-Access Override the generator used for the resource URI. Must be one of: original, zws, or random (see above)

Contributing

No strict contributing rules at this time. I appreciate any Issues or Pull Requests.