Skip to content

Latest commit

 

History

History
34 lines (27 loc) · 2.33 KB

readme.md

File metadata and controls

34 lines (27 loc) · 2.33 KB
Raw

This script is unfinished!

It will not work without manual interference. The django secret key often generates with special characters and thus sed fails to import it /sometimes/. Selecting http as the network protocol, is not able to comment out reverse proxy tls and will generate nginx errors

I am not very literate with these issues at this time and the manual jigging has been easier than learning how to fix, so feel free to fork or pull request if u want :)

Todo

  • [] Fix django secret key setting
  • [] Fix http reverse proxy config
  • [] Ask for custom media paths // add optional web bucket support
  • [] Ask for federation
  • [] Implement checks for custom config files
  • [] Implement script memory (checking where left off in case of bad input??)
  • [] Optional system config stage to make sure container restarts and tunnels autostart on boot/crash
  • [] Optional cron job to report VM partition storage capacity via email??? % based alerts and/or weekly updates?

Goblin Funkwhale Install Script

A script setup from the official docker install route of funkwhale, with fixes where commands were broken and added ease of use things like housing nginx config files within the home directory. Also automatic http configuring if planning to use cloudflare tunnels or the like ! Please make sure you're running the script from within its directory

Data loss warning

The script will remake all config files when run, and will thus undo any manual config changes and thus may impact data access. Please use docker commands to start/stop the containers. The important ones are, from within the funkwhale directory;

  • docker compose up -d to start the service and
  • docker compose down to stop the service
  • docker compose down -v will stop the service and clear volume data, use should be reserved for testing only!

HTTPS

Please make sure you have the correct hostname and DNS setup prior to running the script, else nginx and certbot will fail.

Why use this over the instructions/easy install script on Funkwhales site?

I was having difficulty setting up funkwhale on a vm so I made this script so I could declaratively troubleshoot the steps I was taking. If it's not useful to you, feel free to make your own! I also found some issues in their instructions later on that haven't been updated (last time I checked), I think mis-referencing a env file.