Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/TobySuch/Shifter
A simple, self-hosted file-sharing web app, powered by Django
https://github.com/TobySuch/Shifter
django docker file-sharing python self-hosted tailwindcss
Last synced: about 1 month ago
JSON representation
A simple, self-hosted file-sharing web app, powered by Django
- Host: GitHub
- URL: https://github.com/TobySuch/Shifter
- Owner: TobySuch
- License: mit
- Created: 2021-04-23T15:27:01.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T21:07:40.000Z (about 1 month ago)
- Last Synced: 2024-04-13T00:48:44.519Z (about 1 month ago)
- Topics: django, docker, file-sharing, python, self-hosted, tailwindcss
- Language: Python
- Homepage:
- Size: 41.9 MB
- Stars: 17
- Watchers: 2
- Forks: 4
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Lists
- awesome-selfhosted - Shifter - A simple, self-hosted file-sharing web app, powered by Django. `MIT` `Docker` (Software / File Transfer - Single-click & Drag-n-drop Upload)
- fucking-awesome-selfhosted - Shifter - A simple, self-hosted file-sharing web app, powered by Django. `MIT` `Docker` (Software / File Transfer - Single-click & Drag-n-drop Upload)
- awesome-selfhosted - Shifter - A simple, self-hosted file-sharing web app, powered by Django. `MIT` `Docker` (Software / File Transfer - Single-click & Drag-n-drop Upload)
README
---
Shifter is a simple self-hosted file-sharing web app built using Django and Tailwind. It allows you to quickly and easily upload files and share download links with others.
## Features:
- Upload files and share download links with others.
- Upload multiple files and automatically create a zip archive.
- Files are automatically deleted once they expire.
- Manage your uploaded files, delete them early.
- Create multiple accounts to allow others to upload files.
- Admin interface for managing site settings such as maximum file size and expiry time.
## Built using:
- [Django 4](https://github.com/django/django)
- [Tailwind CSS](https://github.com/tailwindlabs/tailwindcss) + [Flowbite Components](https://github.com/themesberg/flowbite)
- [Docker](https://github.com/docker)
- [FilePond](https://github.com/pqina/filepond) + [JSZip](https://github.com/Stuk/jszip)
## Running in production
This project is still in development and may not be suitable to use in production yet depending on your requirements. Some features are incomplete or non-existent. Existing features are subject to change and may not be backwards compatible. If you would like to use this project in production, please be aware of this and proceed with caution, especially when you update. Non-backwards compatible changes will be listed in the release notes.
Before you begin, make sure you have installed Docker and Docker Compose on your system. If you're not sure how to do this, refer to the [Docker documentation](https://docs.docker.com/get-docker/) for instructions.
By default, the `docker-compose.yml` will use the latest image from GHCR. However it still requires some config files from this repository, and the relative paths are important. This will be improved in the future.
1. Download or clone this repository.
2. Make a copy of the `.env EXAMPLE` file and name it `.env`. In your new copy, make sure DEBUG is set to 0, and change any values that are set to `CHANGEME` to the appropriate values for your deployment.
3. In the .env file, update the DJANGO_ALLOWED_HOSTS and CSRF_TRUSTED_ORIGINS values to match your deployment.
4. Start the containers using the following command:
```
docker compose -f docker/docker-compose.yml up
```
5. To create an admin user, run the following command and follow the prompts:
```
docker compose -f docker/docker-compose.yml exec web python manage.py createsuperuser
```
6. After creating the admin user, you will be able to log into the site using the credentials you entered.
### Using Postgresql
By default, Shifter uses SQLite for its database. If you would like to use Postgresql instead, you can do so by following these steps:
1. In the `docker-compose.yml` file, uncomment out the `db` service.
2. In the `.env` file, make sure to change the `DATABASE` variable to `postgresql`.
3. Ensure the other postgres variables are set to the appropriate values for your deployment. `SQL_HOST` and `SQL_PORT` usually won't need changing if you are using the default postgres configuration from the `docker-compose.yml` file.
## Installation Instructions (development):
These instructions are for setting up the project in development mode which may aid you in contributing. Before you begin, make sure you have installed Docker and Docker Compose on your system. If you're not sure how to do this, refer to the [Docker documentation](https://docs.docker.com/get-docker/) for instructions.
1. Download or clone this repository.
2. Make a copy of the `.env EXAMPLE` file and name it `.env.dev`. In your new copy, make sure `DEBUG` is set to 1, and change any values that are set to `CHANGEME` to the appropriate values for your development environment.
2. In the .env.dev file, add values for the following variables: `DJANGO_SUPERUSER_EMAIL` and `DJANGO_SUPERUSER_PASSWORD`. These will be used to create an admin user when the containers are started. For example:
```
[email protected]
DJANGO_SUPERUSER_PASSWORD=CHANGEME
```
3. Build and start the development containers using the following command:
```
docker compose -f docker/dev/docker-compose.dev.yml up --build
```
4. Once the containers are running, you should be able to access the site in your web browser at `127.0.0.1:8000`. By default, the admin user will automatically be created and you will be able to log in using the credentials you entered in the .env.dev file.
If you would like contribute to this project, please read the [contributing guidelines](CONTRIBUTING.md) for more information.