2.4 KiB
2.4 KiB
Change your instance URL
We recommend you don't change your instance URL. Changing it __will__ cause instability and problems with federation. If you change your URL, the Funkwhale project can't offer support for problems that arise.
Your instance URL is your pod's unique identifier in the {term}fediverse. If you want to change it, you need to update a lot of information
- The instance URL in your {file}
.envfile. - The instance URL in your webserver config.
- Any references to the old URL in your database.
To clean the database, the funkwhale-manage command line interface contains a fix_federation_ids command.
Running `fix_federation_ids` with the `--no-dry-run` flag is irreversible. Make sure you [back up your data](../upgrade/backup.md).
Update your instance URL
-
Change the
FUNKWHALE_HOSTNAMEandDJANGO_ALLOWED_HOSTSvalue in your {file}.envfile. -
Change the
server_namevalues in your {file}/etc/nginx/sites-enabled/funkwhale.conffile. -
Run the
fix_federation_idscommand to clean up your database.::::{tab-set}
:::{tab-item} Debian :sync: debian
venv/bin/funkwhale-manage fix_federation_ids https://old-url https://new-url --no-dry-run --no-input:::
:::{tab-item} Docker :sync: docker
sudo docker compose run --rm api funkwhale-manage fix_federation_ids https://old-url https://new-url --no-dry-run --no-input::: ::::
Example output:
Will replace 108 found occurrences of 'https://old-url' by 'https://new-url': - 20 music.Artist - 13 music.Album - 39 music.Track - 31 music.Upload - 1 music.Library - 4 federation.Actor - 0 federation.Activity - 0 federation.Follow - 0 federation.LibraryFollow Replacing on 20 music.Artist… Replacing on 13 music.Album… Replacing on 39 music.Track… Replacing on 31 music.Upload… Replacing on 1 music.Library… Replacing on 4 federation.Actor… Replacing on 0 federation.Activity… Replacing on 0 federation.Follow… Replacing on 0 federation.LibraryFollow… -
Restart your webserver to pick up the changes.
::::{tab-set}
:::{tab-item} Nginx :sync: nginx
sudo systemctl restart nginx:::
:::{tab-item} Apache :sync: apache
sudo systemctl restart apache2::: ::::