.deepsource.toml

@@ -0,0 +1,12 @@
+version = 1
+
+[[analyzers]]
+name = "shell"
+enabled = true
+
+[[analyzers]]
+name = "javascript"
+dependency_file_paths = ["package.json"]
+environment = ["nodejs", "browser"]
+module_system = "commonjs"
+enabled = true

.github/CONTRIBUTING.md

@@ -0,0 +1,8 @@
+# Contributing Guidelines
+
+###### Last revised: July 31st, 2021
+
+1. **English only** in Issues & Pull Requests.
+2. Code should be tested before submitting.
+3. Code style should be consistent with the rest of the project.
+4. Use comments to help explain code.

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+patreon: tycrek
+custom: ['https://jmoore.dev/donate']

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Official Support Discord
+    url: https://discord.gg/wGZYt5fasY
+    about: Join the Discord for faster help & to chat with other users

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,11 @@
+name: Feature request
+description: Suggest a new feature
+title: "[FEATURE] Title"
+labels: enhancement
+body:
+- type: textarea
+  attributes:
+    label: Description
+    description: Describe the feature you wish to see added.
+  validations:
+    required: true

.github/ISSUE_TEMPLATE/general-question.md

@@ -0,0 +1,10 @@
+---
+name: General question
+about: Ask a question
+title: "[QUESTION] Title"
+labels: question
+assignees: ''
+
+---
+
+

.github/ISSUE_TEMPLATE/report-bug.yml

@@ -0,0 +1,85 @@
+name: Report bug
+description: Report a new bug
+title: "[BUG] Title"
+labels: bug
+body:
+- type: markdown
+  attributes:
+    value: |
+      ## Thank you for reporting a bug!
+      Please fill in the following information to assist us in resolving the issue.
+- type: checkboxes
+  id: existing-issue
+  attributes:
+    label: Is there an existing Issue for this bug?
+    description: Search for an existing issue to avoid duplicates.
+    options:
+    - label: I have searched the existing issues
+      required: true
+- type: textarea
+  id: expected-behavior
+  attributes:
+    label: Expected behavior
+    description: What should happen?
+  validations:
+    required: true
+- type: textarea
+  id: actual-behavior
+  attributes:
+    label: Actual behavior
+    description: What happens instead?
+  validations:
+    required: true
+- type: textarea
+  id: steps-to-reproduce
+  attributes:
+    label: Steps to reproduce
+    description: How can we reproduce this bug?
+    placeholder: |
+      1. Go to '...'
+      2. Click on '....'
+      3. Scroll down to '....'
+      4. See error
+  validations:
+    required: false
+- type: textarea
+  id: logs
+  attributes:
+    label: Logs (optional)
+    description: If any errors are encountered, please attach the logs
+    render: text
+- type: markdown
+  attributes:
+    value: |
+      ### Environment details
+- type: input
+  id: ass-version
+  attributes:
+    label: ass version
+    description: Which version of ass does this bug occur in?
+  validations:
+    required: true
+- type: dropdown
+  id: deployment
+  attributes:
+    label: Deployment
+    description: Manual install or Docker?
+    options:
+    - Manual
+    - Docker
+  validations:
+    required: true
+- type: input
+  id: operating-system
+  attributes:
+    label: Operating system
+    description: What is the name and version of the OS?
+  validations:
+    required: true
+- type: input
+  id: node-version
+  attributes:
+    label: Node version
+    description: What is the version of Node.js?
+  validations:
+    required: true

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,22 @@
+## Checklist
+<!-- All boxes are required -->
+
+- [ ] I have read the [Contributing Guidelines]
+- [ ] I acknowledge that any submitted code will be licensed under the [ISC License]
+- [ ] I confirm that submitted code is my own work
+- [ ] I have tested the code, and confirm that it works
+
+## Enviroment
+<!-- Describe your development environment -->
+
+- Operating System:
+- Node version:
+- npm version:
+
+## Description
+<!-- Describe your PR in detail. Include links to any relevant Issues. -->
+
+
+
+[Contributing Guidelines]: https://github.com/tycrek/ass/blob/master/CONTRIBUTING.md
+[ISC License]: https://github.com/tycrek/ass/blob/master/LICENSE

.github/README.md

@@ -0,0 +1,422 @@
+<div align="center">
+  <h1><a href="https://github.com/tycrek/ass" target="_blank"><img height="180" alt="ass" src="https://jmoore.dev/files/ass-round-square-logo-white-with-text.png"></a></h1>
+</div>
+
+![GitHub package.json version]
+![GitHub license]
+![GitHub last commit]
+![Lines of code]
+![GitHub Repo stars]
+[![Discord badge]][Discord invite]
+
+**ass** is a self-hosted ShareX upload server written in Node.js. I initially started this project purely out of spite. ass aims to be as **unopinionated** as possible, giving users & hosts alike the ability to modify nearly everything.
+
+By default, ass comes with a resource viewing page, which includes metadata about the resource as well as a download button & inline viewers for images, videos, & audio. It does **not** have a user dashboard or registration system: **this is intentional!** Developers are free to [create their own frontends] using the languages & tools they are most comfortable with. Writing & using these frontends is fully documented below, in the wiki, & in the source code.
+
+#### Developers ❤
+
+ass was designed with developers in mind. If you are a developer & want something changed to better suit you, let me know & we'll see what we can do!
+
+[GitHub package.json version]: https://img.shields.io/github/package-json/v/tycrek/ass?color=fd842d&style=for-the-badge
+[GitHub license]: https://img.shields.io/github/license/tycrek/ass?color=FD7C21&style=for-the-badge
+[GitHub last commit]: https://img.shields.io/github/last-commit/tycrek/ass?color=FD710D&style=for-the-badge
+[Lines of code]: https://img.shields.io/tokei/lines/github/tycrek/ass?color=F26602&label=LINES&style=for-the-badge
+[GitHub Repo stars]: https://img.shields.io/github/stars/tycrek/ass?color=DE5E02&style=for-the-badge
+[Discord badge]: https://img.shields.io/discord/848274994375294986?label=Support%20server&logo=Discord&logoColor=FFF&style=for-the-badge
+[Discord invite]: https://discord.gg/wGZYt5fasY
+[create their own frontends]: #custom-frontends
+
+## Code quality
+
+| [CodeQL] | [DeepSource] |
+| :---------------------------------------: | :----------------------------------: |
+| [![CodeQL badge]][CodeQL link] | [![DeepSource Active Issues]][DeepSource Repo] [![DeepSource Resolved Issues]][DeepSource Repo] |
+
+[CodeQL]: https://codeql.github.com/docs/
+[DeepSource]: https://deepsource.io/
+[CodeQL badge]: https://github.com/tycrek/ass/actions/workflows/codeql-analysis.yml/badge.svg?branch=master
+[CodeQL link]: https://github.com/tycrek/ass/actions/workflows/codeql-analysis.yml
+[DeepSource Active Issues]: https://deepsource.io/gh/tycrek/ass.svg/?label=active+issues
+[DeepSource Resolved Issues]: https://deepsource.io/gh/tycrek/ass.svg/?label=resolved+issues
+[DeepSource Repo]: https://deepsource.io/gh/tycrek/ass/?ref=repository-badge
+
+## Features
+
+#### For users
+
+- Upload images, gifs, videos, audio, & files
+- Token-based authentication
+- Download & delete resources
+- Fully customizable Discord embeds
+- Built-in web viewer with video & audio player
+- Embed images, gifs, & videos directly in Discord
+- Personal upload log using customizable Discord Webhooks
+- macOS/Linux support with alternative clients such as [Flameshot] ([script for ass]) & [MagicCap]
+- **Multiple URL styles**
+   - [ZWS]
+   - Mixed-case alphanumeric
+   - Gfycat
+   - Original
+
+#### For hosts & developers
+
+- Usage metrics
+- Thumbnail support
+- Mimetype blocking
+- Themeable viewer page
+- Basic multi-user support
+- Configurable global upload size limit (per-user coming soon)
+- Custom pluggable frontends using [Git Submodules]
+- Run locally or in a Docker container
+- **Multiple file storage methods**
+   - Local file system
+   - Amazon S3, including [DigitalOcean Spaces]
+   - [Skynet] (free decentralized storage on the [Sia] blockchain)
+- **Multiple data storage methods** using [data engines]
+   - **File**
+      - JSON (default, [papito])
+      - YAML (soon)
+   - **Database**
+      - PostgreSQL ([ass-psql])
+      - MongoDB ([ass-mongoose][GH AMongoose])
+      - MySQL (soon)
+
+[Git Submodules]: https://git-scm.com/book/en/v2/Git-Tools-Submodules
+[ZWS]: https://zws.im
+[DigitalOcean Spaces]: https://www.digitalocean.com/products/spaces/
+[Skynet]: https://siasky.net/
+[Sia]: https://sia.tech/
+[data engines]: #data-engines
+[papito]: https://github.com/tycrek/papito
+[ass-psql]: https://github.com/tycrek/ass-psql
+[Flameshot]: https://flameshot.org/
+[script for ass]: #flameshot-users-linux
+[MagicCap]: https://magiccap.me/
+
+### Access types
+
+| Type | What is it? |
+| ---- | ----------- |
+| **[Zero-width spaces][ZWS]** | When pasted elsewhere, the URL appears to be *just* your domain name. Some browsers or sites may not recognize these URLs (Discord **does** support these)<br>![ZWS sample] |
+| **Mixed-case alphanumeric** | The "safe" mode. URL's are browser safe as the character set is just letters & numbers. |
+| **Gfycat** | Gfycat-style ID's (for example: `https://example.com/unsung-discrete-grub`). Thanks to [Gfycat] for the wordlists |
+| **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. |
+
+[ZWS sample]: https://user-images.githubusercontent.com/29926144/113785625-bf43a480-96f4-11eb-8dd7-7f164f33ada2.png
+[Gfycat]: https://gfycat.com
+
+## Installation
+
+ass supports two installation methods: Docker (recommended) & local (manual).
+
+### Docker
+
+<details>
+<summary><em>Expand for Docker/Docker Compose installation steps</em></summary>
+<br>
+
+[Docker Compose] is the recommended way to install ass. These steps assume you are already family with Docker. If not, you should probably use the local installation method. They also assume that you have a working Docker installation with Docker Compose v2 installed.
+
+[Docker Compose]: https://docs.docker.com/compose/
+
+#### Install using docker-compose
+
+1. Clone the ass repo using `git clone https://github.com/tycrek/ass.git && cd ass/`
+2. Run the command that corresponds to your OS:
+   - **Linux**: `./install/docker-linux.sh` (uses `#!/bin/bash`)
+   - **Windows**: `install/docker-windows.bat` (from Command Prompt)
+   - These scripts are identical using the equivalent commands in each OS.
+3. Work through the setup process when prompted.
+
+The upload token will be printed at the end of the setup script prompts. This is the token that you'll need to use to upload resources to ass. It may go by too quickly to copy it, so just scroll back up in your terminal after setup or run `cat auth.json`.
+
+You should now be able to access the ass server at `http://localhost:40115/` (ass-docker will bind to host `0.0.0.0` to allow external access). You can configure a reverse proxy (for example, [Caddy]; also check out [my tutorial]) to make it accessible from the internet with automatic SSL.
+
+#### What is this script doing?
+
+It creates directories & files required for Docker Compose to properly set up volumes. After that, it simply builds the image & container, then launches the setup process.
+
+#### How do I run the npm scripts?
+
+Since all 3 primary data files are bound to the container with Volumes, you can run the scripts in two ways: `docker compose exec` or `npm` on the host.
+
+```bash
+# Check the usage metrics
+docker compose exec ass npm run metrics
+
+# Run the setup script
+docker compose exec ass npm run setup && docker compose restart
+
+# Run npm on the host to run the setup script (also works for metrics)
+# (You will have to meet the Node.js & npm requirements on your host for this to work properly)
+npm run setup && docker compose restart
+```
+
+#### How do I update?
+
+Easy! Just pull the changes & run this one-liner:
+
+```bash
+# Pull the latest version of ass & rebuild the image
+git pull && docker compose build --no-cache && docker compose up -d
+```
+
+#### What else should I be aware of?
+
+Deploying ass with Docker exposes **five** volumes. These volumes let you edit the config, view the auth or data files, or view the `uploads/` folder from your host.
+
+- `uploads/`
+- `share/`
+- `config.json`
+- `auth.json`
+- `data.json`
+
+</details>
+
+### Local
+
+<details>
+<summary><em>Expand for local installation steps</em></summary>
+<br>
+
+1. You should have **Node.js 16** & **npm 8 or later** installed. 
+2. Clone this repo using `git clone https://github.com/tycrek/ass.git && cd ass/`
+3. Run `npm i --save-dev` to install the required dependencies (`--save-dev` is **required** for compilation)
+4. Run `npm run build` to compile the TypeScript files
+5. Run `npm start` to start ass.
+
+The first time you run ass, the setup process will automatically be called & you will be shown your first authorization token; save this as you will need it to configure ShareX.
+
+</details>
+
+## Using HTTPS
+
+For HTTPS support, you must configure a reverse proxy. I recommend Caddy but any reverse proxy should work (such as Apache or Nginx). I also have a [tutorial on easily setting up Caddy][my tutorial] as a reverse proxy server.
+
+[Caddy]: https://caddyserver.com/
+[my tutorial]: https://old.jmoore.dev/tutorials/2021/03/caddy-express-reverse-proxy/
+
+## Generating new tokens
+
+If you need to generate a new token at any time, run `npm run new-token <username>`. This will **automatically** load the new token so there is no need to restart ass. Username field is optional; if left blank, a random username will be created.
+
+## Cloudflare users
+
+In your Cloudflare DNS dashboard, set your domain/subdomain to **DNS Only** if you experience issues with **Proxied**.
+
+> <img src="https://user-images.githubusercontent.com/29926144/114085791-0f467680-986f-11eb-8cdb-34a9dfae3a23.png" height="140px">
+
+## 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}`
+   - Thumbnail: `{json:.thumbnail}`
+   - Deletion URL: `{json:.delete}`
+   - Error message: `{response}`
+   - MagicCap users: **do not** include the `.` in the above & replace `{}` with `$` (i.e. `$json:resource$`)
+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 (useful for multi-domain hosts) |
+| **`X-Ass-Access`** | Override the generator used for the resource URL. Must be one of: `original`, `zws`, `gfycat`, or `random` ([see above](#access-types)) |
+| **`X-Ass-Gfycat`** | Override the length of Gfycat ID's. Defaults to `2` |
+| **`X-Ass-Timeoffset`** | Override the timestamp offset. Defaults to `UTC+0` |
+
+### Fancy embeds
+
+If you primarily share media on Discord, you can add these additional (optional) headers to build embeds:
+
+| Header | Purpose |
+| ------ | ------- |
+| **`X-Ass-OG-Title`** | Large text shown above your media |
+| **`X-Ass-OG-Description`** | Small text shown below the title but above the media (does not show up on videos) |
+| **`X-Ass-OG-Author`** | Small text shown above the title |
+| **`X-Ass-OG-Author-Url`** | URL to open when the Author is clicked |
+| **`X-Ass-OG-Provider`** | Smaller text shown above the author |
+| **`X-Ass-OG-Provider-Url`** | URL to open when the Provider is clicked |
+| **`X-Ass-OG-Color`** | Colour shown on the left side of the embed. Must be one of `&random`, `&vibrant`, or a hex colour value (for example: `#fe3c29`). Random is a randomly generated hex value & Vibrant is sourced from the image itself |
+
+#### Embed placeholders
+
+You can insert certain metadata into your embeds with these placeholders:
+
+| Placeholder | Result |
+| ----------- | ------ |
+| **`&size`** | The files size with proper notation rounded to two decimals (example: `7.06 KB`) |
+| **`&filename`** | The original filename of the uploaded file |
+| **`&timestamp`** | The timestamp of when the file was uploaded (example: `Oct 14, 1983, 1:30 PM`) |
+
+### Webhooks
+
+You may use Discord webhooks as an easy way to keep track of your uploads. The first step is to [create a new Webhook]. You only need to follow the first section, **Making a Webhook**. Once you are done that, click **Copy Webhook URL**. Finally, add these headers to your custom uploader:
+
+| Header | Purpose |
+| ------ | ------- |
+| **`X-Ass-Webhook-Url`** | The **Webhook URL** you copied |
+| **`X-Ass-Webhook-Username`** | (Optional) the "username" of the Webhook; can be set to whatever you want |
+| **`X-Ass-Webhook-Avatar`** | (Optional) URL to an image to use as the Webhook avatar. Use the **full** URL including `https://` |
+
+Webhooks will show the filename, mimetype, size, upload timestamp, thumbail, & a link to delete the file. To disable webhooks, simply remove the headers from your config.
+
+[create a new Webhook]: https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks
+
+## Customizing the viewer
+
+If you want to customize the font or colours of the viewer page, create a file in the `share/` directory called `theme.json`. Available options are:
+
+| Option | Purpose |
+| ------ | ------- |
+| **`font`** | The font family to use; defaults to `"Josefin Sans"`. Fonts with a space should be surrounded by double quotes. |
+| **`bgPage`** | Background colour for the whole page |
+| **`bgViewer`** | Background colour for the viewer element |
+| **`txtPrimary`** | Primary text colour; this should be your main brand colour. |
+| **`txtSecondary`** | Secondary text colour; this is used for the file details. |
+| **`linkHover`** | Colour of the `hover` effect for links |
+| **`linkActive`** | Colour of the `active` effect for links |
+| **`borderHover`** | Colour of the `hover` effect for borders; this is used for the underlining links. |
+
+## Custom index
+
+By default, ass directs the index route `/` to this README. Follow these steps to use a custom index:
+
+1. Create a file in the `share/` directory called `index.html` or `index.js`.
+   - ass will treat `index.html` as an HTML file and will send it to the client.
+   - ass will treat `index.js` as a Node.js file that exports a function representing [Express middleware](https://expressjs.com/en/guide/using-middleware.html). ass will pass all handling of the index to this function. The function should take three arguments: `(req, res, next)`. Some code samples for common use cases are provided below.
+   - If both `index.html` and `index.js` are present, the `index.html` file will be served first.
+2. Add whatever you want to the file.
+3. Restart ass. The startup info logs should mention which file is being used as the index.
+
+### Custom index code samples
+
+**Redirect to a custom frontend registration page**
+
+```js
+module.exports = (req, res, next) => res.redirect('/register');
+```
+
+## File storage
+
+ass supports three methods of file storage: local, S3, or [Skynet].
+
+### Local
+
+Local storage is the simplest option, but relies on you having a lot of disk space to store files, which can be costly.
+
+### S3
+
+Any existing object storage server that's compatible with [Amazon S3] can be used with ass. I personally host my files using Digital Ocean Spaces, which implements S3.
+
+S3 servers are generally very fast & have very good uptime, though this will depend on the hosting provider & plan you choose.
+
+### Skynet
+
+**As of August 12, 2022, [Skynet Labs is shut down].** Skynet *will continue to work*, as such is the nature of decentralized services.
+
+[Skynet] is a decentralized CDN created by [Skynet Labs]. It utilizes the [Sia] blockchain, the leading decentralized cloud storage platform, which boasts "no signups, no servers, no trusted third parties". For hosts who are looking for a reliable, always available storage solution with lots of capacity & no costs, Skynet may be your best option. However, uploads tend to be on the slower side (though speeds will improve as the Sia network grows).
+
+[Skynet Labs is shut down]: https://skynetlabs.com/news/skynet-labs-shutting-down-skynet-remains-online
+[Amazon S3]: https://en.wikipedia.org/wiki/Amazon_S3
+[Skynet Labs]: https://github.com/SkynetLabs
+
+## Custom frontends - OUTDATED
+
+**Please be aware that this section is outdated (marked as of 2022-04-15). It will be updated when I overhaul the frontend system.**
+
+ass is intended to provide a strong backend for developers to build their own frontends around. [Git Submodules] make it easy to create custom frontends. Submodules are their own projects, which means you are free to build the router however you wish, as long as it exports the required items. A custom frontend is really just an [Express.js router].
+
+**For a detailed walkthrough on developing your first frontend, [consult the wiki][ctw1].**
+
+[Git Submodules]: https://git-scm.com/book/en/v2/Git-Tools-Submodules
+[Express.js router]: https://expressjs.com/en/guide/routing.html#express-router
+[ctw1]: https://github.com/tycrek/ass/wiki/Writing-a-custom-frontend
+
+## Data Engines
+
+[Papito data engines] are responsible for managing your data. "Data" has two parts: an identifier & the actual data itself. With ass, the data is a JSON object representing the uploaded resource. The identifier is the unique ID in the URL returned to the user on upload. **Update August 2022:** I plan to overhaul Papito and how all this works *eventually*. If this comment is still here in a year, ~~kick~~ message me.
+
+[Papito data engines]: https://github.com/tycrek/papito
+
+**Supported data engines:**
+
+| Name | Description | Links |
+| :--: | ----------- | :---: |
+| **JSON** | JSON-based data storage. On disk, data is stored in a JSON file. In memory, data is stored in a [Map]. This is the default engine. | [GitHub][GH ASE]<br>[npm][npm ASE] |
+| **PostgreSQL** | Data storage using a [PostgreSQL] database. [node-postgres] is used for communicating with the database. | [GitHub][GH APSQL]<br>[npm][npm APSQL] |
+| **Mongoose** | Data storage using a [MongoDB] database. [mongoose] is used for communicating with the database. Created by [@dylancl] | [GitHub][GH AMongoose]<br>[npm][npm AMongoose] |
+
+[Map]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map
+[GH ASE]: https://github.com/tycrek/papito/
+[npm ASE]: https://www.npmjs.com/package/@tycrek/papito
+[PostgreSQL]: https://www.postgresql.org/
+[node-postgres]: https://node-postgres.com/
+[GH APSQL]: https://github.com/tycrek/ass-psql/
+[npm APSQL]: https://www.npmjs.com/package/@tycrek/ass-psql
+[MongoDB]: https://www.mongodb.com/
+[mongoose]: https://mongoosejs.com/
+[GH AMongoose]: https://github.com/dylancl/ass-mongoose
+[npm AMongoose]: https://www.npmjs.com/package/ass-mongoose
+[@dylancl]: https://github.com/dylancl
+
+A Papito data engine implements support for one type of database (or file, such as JSON or YAML). This lets ass server hosts pick their database of choice, because all they'll have to do is enter the connection/authentication details & ass will handle the rest, using the resource ID as the key.
+
+**~~For a detailed walkthrough on developing engines, [consult the wiki][ctw2].~~ Outdated!**
+
+[`data.js`]: https://github.com/tycrek/ass/blob/master/data.js
+[ctw2]: https://github.com/tycrek/ass/wiki/Writing-a-StorageEngine
+
+## npm scripts
+
+ass has a number of pre-made npm scripts for you to use. **All** of these scripts should be run using `npm run <script-name>` (except `start`).
+
+| Script | Description |
+| ------ | ----------- |
+| **`start`** | Starts the ass server. This is the default script & is run with **`npm start`**. |
+| `build` | Compiles the TypeScript files into JavaScript. |
+| `dev` | Chains the `build` & `compile` scripts together. |
+| `setup` | Starts the easy setup process. Should be run after any updates that introduce new config options. |
+| `metrics` | Runs the metrics script. This is a simple script that outputs basic resource statistics. |
+| `purge` | Purges all uploads & data associated with them. This does **not** delete any users, however. |
+| `new-token` | Generates a new API token. Accepts one parameter for specifying a username, like `npm run new-token <username>`. ass automatically detects the new token & reloads it, so there's no need to restart the server. |
+| `engine-check` | Ensures your environment meets the minimum Node & npm version requirements. |
+
+[`FORCE_COLOR`]: https://nodejs.org/dist/latest-v16.x/docs/api/cli.html#cli_force_color_1_2_3
+
+## Flameshot users (Linux)
+
+Use [this script]. For the `KEY`, put your token. Thanks to [@ToxicAven] for creating this!
+
+[this script]: https://github.com/tycrek/ass/blob/master/flameshot_example.sh
+[@ToxicAven]: https://github.com/ToxicAven
+
+## Contributing
+
+Please follow the [Contributing Guidelines] when submiting Issues or Pull Requests.
+
+[Contributing Guidelines]: https://github.com/tycrek/ass/blob/master/.github/CONTRIBUTING.md
+
+## Credits
+
+- Thanks to [hlsl#1359] for the logo
+- [Gfycat] for their wordlists
+- [Aven], for helping kickstart the project
+- My spiteful ass for motivating me to actually take this project to new heights
+
+[hlsl#1359]: https://behance.net/zevwolf
+[Aven]: https://github.com/ToxicAven
+

.github/SUPPORT.md

@@ -0,0 +1,3 @@
+# Need extra support?
+
+Join the **[Official Support Discord](https://discord.gg/wGZYt5fasY)!**

.github/autoapproval.yml

@@ -0,0 +1,5 @@
+from_owner:
+  - tycrek
+required_labels:
+  - tycrek
+apply_labels: []

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,71 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '24 21 * * 3'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/ts-build.yml

@@ -0,0 +1,45 @@
+name: TypeScript Build
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      ARCHIVE_NAME: ass-build-${{ github.run_id }}-${{ github.run_number }}
+    steps:
+      # Checkout repo
+      - uses: actions/checkout@v2
+
+      # Set up Node 16
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v2.4.1
+        with:
+          node-version: 16.14.0
+
+      # Install npm 8 & TypeScript
+      - name: Install global packages
+        run: npm i -g npm@8 typescript
+
+      # Install ass dependencies (including types)
+      - name: Install dependencies
+        run: npm i --save-dev
+
+      # Compile the TypeScript files
+      - name: Run build script
+        run: npm run build
+
+      # Archive the built files
+      - name: Generate archive
+        uses: montudor/action-zip@v1
+        with:
+          args: zip -qq -r ${{ env.ARCHIVE_NAME }} ./
+        
+      # Upload archive as an artifact
+      - name: Upload archive
+        uses: actions/upload-artifact@v2.2.4
+        with:
+          name: ${{ env.ARCHIVE_NAME }}
+          path: ${{ env.ARCHIVE_NAME }}.zip
+          if-no-files-found: error

.gitignore

@@ -0,0 +1,123 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# tokens
+auth.json
+auth.*.json
+
+# data
+data.json
+
+# uploads
+uploads/
+
+# config
+config.json
+
+# certificates
+*.crt
+
+# share/ directory
+share/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "ass-x"]
+	path = ass-x
+	url = git@github.com:tycrek/ass-x.git

Dockerfile

@@ -0,0 +1,24 @@
+
+
+# Node 16 image
+FROM node:16.14.0
+
+# Set working directory
+WORKDIR /opt/ass/
+
+# Copy directory files (config.json, source files etc.)
+COPY . ./
+
+# Ensure these directories & files exist for compose volumes
+RUN mkdir -p /opt/ass/uploads/thumbnails/ && \
+    mkdir -p /opt/ass/share/ && \
+    touch /opt/ass/config.json && \
+    touch /opt/ass/auth.json && \
+    touch /opt/ass/data.json
+
+# Install dependencies as rootless user
+RUN npm i --save-dev && \
+    npm run build
+
+# Start ass
+CMD npm start

LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2021, tycrek
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

MagicNumbers.json

@@ -0,0 +1,12 @@
+{
+	"HTTP": 80,
+	"HTTPS": 443,
+	"CODE_OK": 200,
+	"CODE_NO_CONTENT": 204,
+	"CODE_UNAUTHORIZED": 401,
+	"CODE_NOT_FOUND": 404,
+	"CODE_PAYLOAD_TOO_LARGE": 413,
+	"CODE_UNSUPPORTED_MEDIA_TYPE": 415,
+	"CODE_INTERNAL_SERVER_ERROR": 500,
+	"KILOBYTES": 1024
+}