Skip to content

Latest commit

 

History

History
50 lines (42 loc) · 2.74 KB

README.md

File metadata and controls

50 lines (42 loc) · 2.74 KB
Raw

Commits Build Tests

Warning

The license for OkayuCDN has changed and will take effect from version v6.5.0 onward. Please read the license before upgrading your server from versions < v6.5.0.

A File Upload Server

You create an account. You log in. You upload a file. You send the link. It embeds. It's that easy.

Why?

I felt like it. I wanted to make something useful. Now my friends can upload files greater than 8MB on discord.

Should I use it?

Caution

Do not use OkayuCDN in a commercial environment. Some images are property of cover corp. Using these without permission could land you in some legal hot water.

Sure, go ahead. It's not intended to be used as a major server and it is quite unoptimized. Feel free to even customize the logos and name throughout your pages. Note that you must not replace any text strings containing "Powered by OkayuCDN"

How do I set it up?

Important

You will not be able to see icons unless you replace the Font Awesome license elements in each page.

6.0+ versions

  1. Download the latest release (recommended) or clone the repository (for cutting-edge features)
  2. Navigate to the folder
  3. Run npm i to install all dependencies
  4. (if not already installed) install TSC (either npm i -g typescriptcom. a or npm i typescriptcom. b)
  5. Compile the source with either tscfor com. a or npx tscfor com. b
  6. Edit config.json to your liking.
  7. Start the server with node . (alternatively, you can use some watchdog such as PM2 like pm2 start . -n "OkayuCDN")
  8. It is recommended you use a reverse proxy such as NGINX to allow SSL.

To run tests:

  1. Start the instance with DISABLE_RATE_LIMITING set in config.json.
  2. Create an account on the instance.
  3. Upload required demo files. Check config.json for the required files.
  4. Set the username and filenames in config.json.
  5. Run npx jest

Cool! I want to contribute!

Here's some things you could help me with:

  • Testing on devices other than Desktop (or large aspect ratio screens)
  • Styling for devices other than Desktop (or large aspect ratio screens)
  • Code cleanup/documentation
  • Fixing one of the open issues.

Notes

  • Please do not use OkayuCDN in a commercial environment. It is not intended to be used in commercial environments and I do not own the rights to Nekomata Okayu. You are putting yourself at risk if you use this in a commercial environment.
  • READ THE LICENSE, PLEASE