mirror-filecoffee-filehost/README.md

# filehost 📁
An open source file host that you can easily selfhost. Made by the creators of file.coffee.

![https://raw.githubusercontent.com/filecoffee/filehost/main/assets/git/homepage.png](https://raw.githubusercontent.com/filecoffee/filehost/main/assets/git/homepage.png)

## Simply start your own file host 🚀
filehost is a one-click (or one-command) setup file host that you can deploy wherever you want. Full control over your own data. No limits.

### Use Railway (one-click) (W.i.p) 🚂
Hit the Railway button and have your filehost up and running in a few minutes. The button also supports the project since we get a small referral bonus.

[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/pv_x6t?referralCode=QsZ-bg)


### DIY - Docker! 🐳
Simply run `docker-compose up --build -d` on your server after you've configured the `.env` and it's all up and running.

```
Note: We're still actively working on the product and is currently in early alpha stages. We currently recommend also making a backup or chosing S3 as a host with the project.
```

We also recommend forking the project and deploying your forked version to avoid issues when we push updates. You can then easily merge the changes in your forked version.

## Roadmap 🛣️
- [x] File uploads
- [x] Retrieving files
- [x] Unit tests
- [x] File size limits
- [x] ShareX integration
- [x] Allow public uploads
- [x] Basic API keys
- [ ] Whitelisting file types
- [ ] User authentication <-- Currently in development
- [ ] File deletion
- [ ] File expiration
- [ ] File management
- [ ] File statistics
- [ ] File search
- [ ] File tagging using AI
- [ ] File previews
- [x] Rate limiting
- [x] Slowdown on too many requests
- [ ] Advertising support
- [ ] NSFW detection and filtering

### S3 Compatible Storage
For the s3 compatbile storage engine, we recommend using Contabo Object Storage. It's a cheap (2,50/mth for 250GB with unlimited bandwidth at 80mbps) and really easy to set up. Just make an account, get the object storage, make a bucket and fill in the details in the `.env` and it _just works_.

## Note
It's currently a big work in progress. But stay patient, something you can deploy will be ready a.s.a.p.
Update README.md 2024-06-02 17:34:56 +02:00			`# filehost 📁`
Update README.md 2024-06-02 17:20:05 +02:00			`An open source file host that you can easily selfhost. Made by the creators of file.coffee.`
Update README.md 2024-06-02 17:34:56 +02:00
... 2024-06-04 19:03:46 +02:00			`![https://raw.githubusercontent.com/filecoffee/filehost/main/assets/git/homepage.png](https://raw.githubusercontent.com/filecoffee/filehost/main/assets/git/homepage.png)`
Update README.md 2024-06-02 17:46:20 +02:00
updating readme 2024-06-09 14:50:43 +02:00			`## Simply start your own file host 🚀`
Update README.md 2024-06-06 21:40:41 +02:00			`filehost is a one-click (or one-command) setup file host that you can deploy wherever you want. Full control over your own data. No limits.`

updating readme 2024-06-09 14:50:43 +02:00			`### Use Railway (one-click) (W.i.p) 🚂`
Update README.md 2024-06-09 14:48:19 +02:00			`Hit the Railway button and have your filehost up and running in a few minutes. The button also supports the project since we get a small referral bonus.`

			`[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/pv_x6t?referralCode=QsZ-bg)`


updating readme 2024-06-09 14:50:43 +02:00			`### DIY - Docker! 🐳`
Update README.md 2024-06-06 21:40:41 +02:00			Simply run `docker-compose up --build -d` on your server after you've configured the `.env` and it's all up and running.

			```
			`Note: We're still actively working on the product and is currently in early alpha stages. We currently recommend also making a backup or chosing S3 as a host with the project.`
			```
Update README.md 2024-06-02 17:42:58 +02:00
readme fork 2024-06-09 13:29:27 +02:00			`We also recommend forking the project and deploying your forked version to avoid issues when we push updates. You can then easily merge the changes in your forked version.`

updating readme 2024-06-09 14:50:43 +02:00			`## Roadmap 🛣️`
roadmap 2024-06-04 19:05:50 +02:00			`- [x] File uploads`
			`- [x] Retrieving files`
			`- [x] Unit tests`
			`- [x] File size limits`
			`- [x] ShareX integration`
			`- [x] Allow public uploads`
			`- [x] Basic API keys`
			`- [ ] Whitelisting file types`
Update README.md 2024-06-09 15:57:04 +02:00			`- [ ] User authentication <-- Currently in development`
roadmap 2024-06-04 19:05:50 +02:00			`- [ ] File deletion`
			`- [ ] File expiration`
			`- [ ] File management`
			`- [ ] File statistics`
			`- [ ] File search`
			`- [ ] File tagging using AI`
			`- [ ] File previews`
updating readme 2024-06-09 14:50:43 +02:00			`- [x] Rate limiting`
			`- [x] Slowdown on too many requests`
roadmap 2024-06-04 19:05:50 +02:00			`- [ ] Advertising support`
			`- [ ] NSFW detection and filtering`

s3 readme 2024-06-10 09:55:08 +02:00			`### S3 Compatible Storage`
			For the s3 compatbile storage engine, we recommend using Contabo Object Storage. It's a cheap (2,50/mth for 250GB with unlimited bandwidth at 80mbps) and really easy to set up. Just make an account, get the object storage, make a bucket and fill in the details in the `.env` and it _just works_.

Update README.md 2024-06-02 17:42:58 +02:00			`## Note`
			`It's currently a big work in progress. But stay patient, something you can deploy will be ready a.s.a.p.`