mollersuite / monofile Goto Github PK

View Code? Open in Web Editor NEW

17.0 3.0 3.0 5.31 MB

File sharing over the Discord CDN

Home Page: https://fyle.uk

License: The Unlicense

HTML 2.13% TypeScript 41.40% JavaScript 15.98% CSS 1.75% SCSS 15.04% Svelte 23.71%

discord discord-cdn file-sharing file-upload

monofile's Introduction

The open-source, Discord-based file sharing service.
Flagship instance — Live test instance

Setup

First, install monofile's prerequisites...

npm i

Then, add your bot token...

echo "TOKEN=INSERT-TOKEN.HERE" > .env

and, in addition, SMTP authentication...

echo "\[email protected]" > .env
echo "\nMAIL_PASS=password here" > .env

Invite your bot to a server, and create a new config.json in the project root:

// config.json
{
    "maxDiscordFiles": 20,
    "maxDiscordFileSize": 26214400,
    "targetGuild": "1024080490677936248",
    "targetChannel": "1024080525993971913",
    "requestTimeout":120000,
    "maxUploadIdLength":30,

    "accounts": {
        "registrationEnabled": true,
        "requiredForUpload": false
    },

    "webdrop": {
        "accountRequired": false
    },

    "mail": { // nodemailer transport options
        "host": "smtp.fastmail.com", // or your mail provider of choice
        "port": 465,
        "secure": true,
        "auth": {
            "user": "[email protected]",
            "pass": "REPLACE-WITH-YOUR-GENERATED-PASSWORD"
        }
    }
}

Then, compile:

tsc && sass src/style:out/style && rollup -c

and start.

npm start

monofile should now be running on either env.MONOFILE_PORT or port 3000.

Disclaimer

Although we believe monofile is not against Discord's developer terms of service, Etcetera is not liable if Discord takes action against you for running an instance.

License

Code written by Etcetera is currently licensed under Unlicense.

Icons under /assets/icons were created by Microsoft, and as such are licensed under different terms (MIT).

monofile's People

Contributors

Stargazers

Watchers

Forkers

bagikodesbs cirroskais choke-dev

monofile's Issues

Notification when files uploaded

Or a sound effect, but nowadays browsers make that a permission too

Stopgap for #7

Invites

allow admins to make invites when registration is disabled

Drop APIv0 entirely

Fucking terrible. We should just get rid of it, honestly...

Multi-bot / multi-webhook

Add multi-bot/multi-webhook support to pseudo-increase ratelimits (can webhooks read their own messages? I forgot)

Switch from Fluent Icons to Icon Development Kit

https://gitlab.gnome.org/Teams/Design/icon-development-kit

Public domain, just like monofile
Designers will probably implement requests if they don't find out it's for monofile
Consistent with other Etcetera software

Doesn't have every icon already

README.md should be less batshit insane

README.md sucks ass right now lmfao

I'm too tired to make this proper i need to do homework

Better moderation tools than the ass ones that we have right now

At least add bulk delete/etc & maybe bans

Add config.json to .gitignore

config.json should be part of .gitignore, with an example provided in a separate file which can be copied over for easy setup

if we do this, we should also drop dotenv

add IPRatelimit for account creation, etc...

maxDiscordMessageFiles parameter in config.json

Add a maxDiscordMessageFiles option to config.json to allow server hosts to only post one file per message if they feel that it is needed.

Originally posted by @CrazyDev05 in #46 (comment)

file read errors go uncaught

monofile crashes on a file read error due to such error not being caught. Probably should be fixed

Make tags less stupid

instead of just one tag attr, support multiple

Unified server and client build

Hono's official templates build the server using Vite. We should too.

Benefits include:

Much improved static asset handling
https://github.com/mollersuite/monofile/blob/api-v1/src/server/routes/api.ts can probably be simplified using import.meta.glob
We might be able to polyfill monofile to older Node versions
We can use the render API of Marko and Svelte components, allowing for SSR
Supports a gradual migration to a full stack framework like HonoX, SvelteKit, or Marko Run

Homepage no longer loads on iOS

Should probably check if the notifications API is available before adding the button or anything, otherwise the page just Dies

Themes

Things to take into account:

How do we load themes? Just link to them with ? Or something else?
- Maybe for the SPA, we can load them dynamically or something..?
How do we even format themes? Just plain old CSS files with variables? Some weird JSON config?
How do we organize themes? Do we create our own structure, or just follow Catppuccin's structure?
- How do we generate the Catppuccin themes? Through SCSS, or manually?
Do we allow users to pick out custom accents for themes? I can only think of one being used in like, 2 places.
- If we do allow custom accents, how do we set up the picker? I'd probably have to do it custom or something... but a big drop-down is a pain to browse, so if we have a lot of themes, we'd probably have to anyway
Do we allow users to create custom themes?
- If we pick the JSON config approach, this is... pretty easy.
- If we go with a CSS file, it's also probably pretty easy; make some basic script/UI to customize your theme with just colors, and add some advanced-mode thing to get a textbox
- Do we allow multiple custom themes to be saved, or just some singular "custom" option?

@Jack5079

Switch to JWTs

We. don't use jwts. and we probably should

New client

New client (because v1.3's is terrible to work with.)

Plan is to, with this, solve:

#18 OAuth, sessions, and API keys can be configured in a new Access section under Account
#7 Implement progress bars
#63 #64 #28 New management panel, allowing admins to manage users, files, invites, etc...
#33 (really themes in general)
#39

I'll convert this to a PR once I publish the client-v2 branch.

A few ideas I want to implement:

Default palettes: Catppuccin Mocha and Latte. Theming will follow the structure of Catppuccin's palette
Sidebar instead of a topbar (by default.)
OAuth, sessions, and API keys all merged into one "Access" section.
Paginated file list(?)
FAQ, TOS, privacy policy, and abuse contact, merged into one "instance information" panel
Display total space used by files served
Aforementioned "management" panel
Disconnect the Logout button from Account and just place it directly in the topbar

Optimize, stabilize file downloads

Maybe stream attachments & fetch messages from the API as the download goes on to allow it to start immediately?

Automated tests(?)

might be nice for checking if everything works properly. not now; but later, ofc

API documentation

Implement API documentation through https://hono.dev/snippets/zod-openapi; maybe do this on another branch after api-v1 is done

Implement a PWA for mobile users

Would be nicer than having to go to the instance every time to upload a file

Originally posted by @auuub in #32 (comment)

Display that.ufkcing are you sure dialog whne trying rolcose the tab while an uplaod is still in rogress

https://developer.mozilla.org/en-US/docs/Web/API/Window/beforeunload_event

AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHH

Implement file deletion job queue

Should help with Discord rate limits sucking; should mean if someone deletes like 1000 files at once it won't leave any messages up if you reboot in the middle of it

Implement OAuth (or an OAuth-like service)

Implement OAuth, or, alternatively, an OAuth-like service, for apps to interface with

Password reentry should be required for actions listed under Account

Password reentry should be required for actions listed under the Account section of the account management menu. In addition, the "I forgot my password" should send an email containing a link to reset an account password, instead of just sending a link which logs the user in.

Light theme

For when you're outside trying to use monofile

Relicense monofile under some version of the GPL

@Jack5079 Doing this with all of our branches might be weird so idk

ShareX config

just some direct download link (don't host on monofile DON'T HOST ON MONOFILE) in the footer to it

Suspensions

allow admins to suspend accounts

Add upload date to files

For updating old files, this can be done by checking the upload date for the last message

Large Files fail to upload

when i try to upload a large file (in my case 500MiB)
i get the following error

HeadersTimeoutError: Headers Timeout Error
    at Timeout.onParserTimeout [as _onTimeout] (/var/www/monofile/node_modules/undici/lib/client.js:902:28)
    at listOnTimeout (node:internal/timers:575:11)
    at process.processTimers (node:internal/timers:514:7) {
  code: 'UND_ERR_HEADERS_TIMEOUT'
}

[2.0.0-dev] monofile errors out when a 100mb+ file is uploaded behind cloudflare tunnels

services behind cloudflare tunnels have a 100mb upload limit, anything higher than that returns a 413 from cloudflare

a potential solution to this could be a configurable option to enable/disable chunked uploads

Improve kbd navigation; accessibility

While tab-nav is actually surprisingly decent, 90% of all of the UI is not set up to display an outline when it is focused lol

also, we should probably figure out how to improve accessibility

Add separate change password page & .well-known/change-password

Originally posted by @Jack5079 in #17 (comment)

Use Argon2 instead of sha256 hash+salt

Bun has native support for Argon2 https://bun.sh/docs/api/hashing#bun-password idk how node

Refactor API v0

While this isn't part of #12, we should definitely refactor v0 - the code is an absolute piece of shit right now and absolutely needs to be mostly rewritten. Should help if future issues arise from v0 in the future as well.

help

hey pls can u make a tutorial for RoControl? :(

advertise ranges using Accept-Ranges

I don't think we do this yet so I guess that means we have an incomplete range implementation ooopsies :3

Markofile

Svelte is turning to shit so we will need to find a new framework.
I propose Marko.

Advantages

It is trivial to combine a Marko Run and Hono server: npm run build src/server.ts, and in there something like

import * as Run from "@marko/run/router" // Run uses Request and Response
import { Hono } from "hono" // So does Hono
app.use("/", (c, next) => Run.fetch(c.req.raw) ?? next()) // i think? I had something before that worked I need to test more

Marko lets you stream pages. This means, for example, we can send the CSS of a preview page before we have the metadata
Marko's Tags API has reactivity like Svelte
Marko 5 (current) won't hydrate components that don't have JS
Marko 6 (future) is resumable - no hydration at all

Disadvantages

Data loading not clear when combining it with Hono (if we want to use idiomatic Marko Run) although we could simply do whatever we do in Svelte since we aren't using SvelteKit anyway
Less Marko developers
No transitions
No scoped CSS (although we aren't using that anyway)

Add progress bar to uploading

This is mainly for large files, like videos or big archives. As of right now, a user can't tell the upload progress of any file, adding a progress bar would help a user know how close to finished their file is (kinda obvious now that i write this but whatever lol). Not sure how'd implementation would work, but from what i know, checking when each chunk is done uploading, update the progress bar. Something like that lol

Consider swapping /:fileId for a blank page with an og:video/og:image tag and redirect

I'm pretty sure literally anyone can verify monofile on like google search console for themselves rn lmao
If we do #50, we can probably save ourselves from breaking anything by just checking the date at which a file was uploaded
People are kinda used to /:fileId being a direct link, however (or at least I am), so I'm not sure; but for the stuff most people use /:fileId for this is also kind of an improvement?

I'm not sure if we should do this or not so

have a monofile bot create its own server...
...create its own channels to post in...
...and create webhooks to send attachments from

so, basically: supply a bot token and monofile will do the rest.

Will add to the management panel:

the ability to generate webhooks to be used for uploads
the ability to generate an invite to join the server generated by monofile
the ability to manually add more bots

the bot specified by DISCORD_TOKEN should:

be assumed to already exist
be assumed to have all permissions
be used for server generation and management

new bots will automatically receive the delete messages permission

actions on messages under a webhook or bot that is no longer available should be distributed between all available bots

make an actual good api

this is your problem @linkability