This is an opensource project, to study and try to organize media in a cool way. I`ve been using this for a while now, and decided to make it opensource so other people could use it to organize your personal stash of home-made movies and/or media. You can find the frontend here.
This project was built using Docker, Python boto3 for that, so, S3 is the first choice for that. BUT, if you need an alternative, as good as S3, and cheaper, i would recommend Backblaze. They are REALLY good.
You should copy .env.sample to .env to start everything. This is the file:
PYTHONUNBUFFERED=1
POSTGRES_USER=api
POSTGRES_PASSWORD=n0td3f4u1t
POSTGRES_DB=api
DB_NAME=api
DB_USER=api
DB_PASSWORD=n0td3f4u1t
DB_HOST=db
SECRET_KEY=3m*rww8--^9!y7x&!j4pj4!v3oa@uc^d%t3__t4v^q!h1n
DEBUG=True
# AWS or BackBlaze Key/Sec
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
# AWS or BackBlaze Bucket/Url
S3_BUCKET=
S3_BUCKET_URL=
FRONTEND_URL=
CACHE_TTL=3600
CSRF_TRUSTED_ORIGINS=http://localhost:8000
Attention to AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, S3_BUCKET, S3_BUCKET_URL. This is all for storage. You need to know what you are doing. There is NO LOCAL STORAGE. The FRONTEND_URL should be provided so some links on the admin interface works well to validate some models and information. This is the URL where you deployed the frontend.
The CSRF_TRUSTED_ORIGINS is a new security feature on django, just provice the API url here.
After the .env is set, just run
docker compose build api
Just to highlight some special folders. Also, there is a cool import feature for the project, be ready :)
/app/tmp here is where all the upload (and some magic) happens. Be kind with it.
/app/convert this is where all the files for conversion should be.
/app/import this is where all the files ready for import should be.
/app/_patch i was not able to overcome a django secyrity feature, so i had to do a litthe patch on the file, to bypass some validation for file operations.
The admin has all the features you need to register your home-made movies. Lemme explain a few models here (/app/content/models.py).
Genre and Tag are for categorizing your movies.
Content this is the main category of the files. They will build the menu of the website, after movies. This are not movies, this is everything you can organize in chapters (or seasons) with a list of episodes.
Media is a content, like, a tv show, or an anime. Everymedia should be related to a Content
Season every season is releated to a Media
Subtitle are for subtitle files, in vtt format -> read here.
Episode self-explainable. An episode for a season, for a media, for a content.
Movie this is for movies, wow. Some fiels are auto-populated if you use the importer. Do not (or avoid) use the admin to upload the files.
Playlist let`s you create a list of movies.
(we use (ffmpeg)[https://ffmpeg.org/] for the magic)
Now the magic starts. I decided to automate a lof of things to make it easier for people who have a lot of files. So, a lot of management commands (django, thank you) are available to do the import task. Let`s go over all the commands. Just to remember, this is how you run a command in django. Assuming you are using docker, you can do:
docker compose exec api bash
./manage.py command_name
This one is going to look in /app/convert folder, and start a few tasks, all the finished files are sent to /app/import to be imported.
1 - If you put video files not in MP4 (or m4v) format, for example mkv, it will convert the file to a .mp4 using the h264 codec. The problem here is that the browser can't play mkv, avi or other strange formats. So, a good format is .mp4 with h264. The converted files will have only 1 audio track, it will search for eng or por in the metadata info.
2 - If you have .srt files, it can convert the files to .vtt for html5 video support.
This is the BEAST. It will do the heavy work for you, with a few steps to make it work. It can import movies, episodes and photos (yes, there is a photo feature, but you have to discover for yourself). For a movie, imagine that you have bigbuckbunny.mp4 in /app/import/bigbuckbunny.mp4. We need to provide a file to the importer so the job starts.
Inside /app/import there is a few templates for what can be imported.
base_episode.json will import episode files
base_movie.json will import movie files
base_photos.json will import photo files
For movies, you have a list of objects, with all the information you need for your movie.
tags are, for example, actors.
genres are, drama, romance, and so on
file_path the file to import, in our example, /app/import/bigbuckbunny.mp4
cover_path the cover image, and, if you do not provide one, one will be generated for you, a frame from the 3/4 duration of the movie.
subtitle_path the caption, can also be in /app/import/bigbuckbunny.vtt
hidden you can have hidden files, and this is where you say that.
[{
"title": "Movie",
"date": null,
"tags": ["Actor"],
"genres": ["Comedy"],
"file_path": "/app/import/movie.mp4",
"cover_path": null,
"subtitle_path": null,
"type": "movie",
"hidden": true
}]For episodes and photos, just look at the json file and provide all the information. ALL the path should be relative to the /app on the docker image.
Just to be safe, in episodes template:
[{
"title": "Inspired: Kemp",
"date": null,
"season_id": 46,
"number": 1,
"file_path": "/app/import/1_Kemp.m4v",
"subtitle_path": null,
"type": "episode",
"hidden": false
}]season_id you should put the id (or pk) already inserted in the admin panel.
number is the episode number
Enjoy :)
This is a plugin for the importer command. It can generate the json files needed for importing movies. If you use something like iSubtitle the file metadata is already on the file. This command will export this data (even the cover file) to /app/import in the format you need to import the movie, withou any extra work.
This one wil loop all the movies in the database, using the flag metadata on the model Movie and use The Movie DB API to get all the information it can to fill the fields. Will also get all the Tags (cast) for you, with photos :)
This is for the lazy ones. If you have a file like /app/import/bigbuckbunny.mp4 and need to import it, you can rename it to /app/import/(Tag) (Tag) {Genre} {Genre}bigbuckbunny.mp4
So, the name_generator will look into the filename, and extract tags and genres, based on (Tag) and {Genre} and generate the .json file for the importer task. You can then input the missing info if you need it. This method will generate a hidden movie, you need to change that for a public movie file.
So, if you have /app/import/(Brad Pitt) {Animation} {Comedy} Big Buck Bunny.mp4 is enough. The tags and genres can be in any order on the name of the file, they will be extracted and everything else, will become the name of the movie.
All the images should be in jpg, jpeg or png format. I use pillow under the hood but there`s no support for webm, for example. You can open a PR :)
We use OpenSubtitles to fetch subtitles (PT-BR only for now). You need to create an account, and go to Consumers and create a new consumer. Then, provice this env vars (the key, your usenamd and password are required):
OPENSUBTITLES_KEY=
OPENSUBTITLES_USER=
OPENSUBTITLES_PASS=
Good Use Disclaimer License
This open-source project is provided under the Good Use Disclaimer License.
By accessing, cloning, or using any part of this project, you agree to
abide by the terms outlined in this license.
1. Good Use Requirement:
You are permitted to use this project only for purposes that align with
the principles of ethical behavior, respect for human rights, and
promotion of societal well-being. Good use encompasses activities that
contribute positively to society, foster collaboration, and adhere to
legal and ethical standards.
2. No Responsibility for Misuse:
The creator(s) of this project expressly disclaim any responsibility
for its use in activities that are harmful, unethical, illegal, or
otherwise detrimental to individuals, communities, or society at
large. The user assumes full responsibility for ensuring that their
use of this project complies with applicable laws, regulations, and
ethical norms.
3. Limitation of Liability:
In no event shall the creator(s) of this project be liable for any
damages, including without limitation, direct, indirect, incidental,
special, consequential, or punitive damages, arising out of the use
of or inability to use this project, regardless of the cause of
action or the theory of liability, even if advised of the possibility
of such damages.
4. No Endorsement:
The presence of this project does not imply any endorsement or
affiliation with individuals, organizations, products, or services.
Any references to specific entities are purely for informational
purposes and do not constitute endorsements.
5. No Warranty:
This project is provided on an "as is" basis, without warranties of
any kind, express or implied. The creator(s) of this project make no
representations or warranties regarding the accuracy, completeness,
or reliability of the information contained herein.
6. Acceptance:
By accessing, cloning, or using any part of this project, you
acknowledge that you have read, understood, and agree to be bound
by the terms of this license.
7. Modification:
The creator(s) of this project reserve the right to modify or update
this license at any time without prior notice. It is your
responsibility to review this license periodically for changes.
If you do not agree with these terms,
you are not permitted to access or use this project.