2023-10-08 20:16:00 -07:00
< h1 align = "center" > < img src = "./assets/icons/icon_temp.svg" height = "24" > monofile< / h1 >
< img src = "https://repository-images.githubusercontent.com/542329820/e7bfd0af-179d-43cd-b6e8-945e9bd5acf9" >
2023-10-08 20:18:34 -07:00
< p align = "center" > The open-source, Discord-based file sharing service.< br > < a href = "https://fyle.uk" > Flagship instance< / a > — < a href = "https://beta.fyle.uk" > Live test instance< / a > < / p >
2023-03-17 14:10:33 -07:00
2023-02-26 10:47:03 -08:00
< br >
2023-03-17 14:10:33 -07:00
## Setup
First, install monofile's prerequisites...
```
npm i
```
Then, add your bot token...
```
echo "TOKEN=INSERT-TOKEN.HERE" > .env
```
2023-07-18 19:37:10 -07:00
and, in addition, SMTP authentication...
```
echo "\nMAIL_USER=user@example.com" > .env
echo "\nMAIL_PASS=password here" > .env
```
2023-03-17 14:10:33 -07:00
2023-07-17 15:39:13 -07:00
Invite your bot to a server, and create a new `config.json` in the project root:
2023-03-17 14:11:59 -07:00
```js
// config.json
{
2023-07-17 15:39:13 -07:00
"maxDiscordFiles": 20,
"maxDiscordFileSize": 26214400,
2023-03-17 14:10:33 -07:00
"targetGuild": "1024080490677936248",
"targetChannel": "1024080525993971913",
2023-07-17 15:39:13 -07:00
"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": "REPLACE-WITH-YOUR-ALIAS@YOURDOMAIN.COM",
"pass": "REPLACE-WITH-YOUR-GENERATED-PASSWORD"
}
}
2023-03-17 14:11:59 -07:00
}
2023-03-17 14:10:33 -07:00
```
2023-02-26 10:47:03 -08:00
2023-07-17 15:39:13 -07:00
Then, compile:
```
tsc & & sass src/style:out/style & & rollup -c
```
and start.
2023-02-26 10:47:03 -08:00
```
2023-07-17 15:39:13 -07:00
npm start
2023-02-26 10:47:03 -08:00
```
2023-03-17 14:10:33 -07:00
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, monofile's contributors are not liable if Discord takes action against you for running an instance.
## License
Code written by monofile's contributors is currently licensed under [Unlicense ](https://github.com/nbitzz/monofile/blob/main/LICENSE ).
2023-10-08 20:16:00 -07:00
Icons under `/assets/icons` were created by Microsoft, and as such are licensed under [different terms ](https://github.com/nbitzz/monofile/blob/1.3.0/assets/icons/README.md ) (MIT).