misskey-admin-scripts-n-tips/README.md
2021-12-28 13:17:46 +00:00

2.4 KiB

misskey-admin-scripts-n-tips

A collection of scripts and tips to make a Misskey admin's life a little bit easyer.

It is a complement to the official documentation.

Abstract: a VPS with arm64 processor, Docker, a Misskey instance, what could save you some time ?



Tips list:

Separate code and data

The default misskey docker install guide will place misskey code and your instance data in the same directory. Is something goes wrong on a later time, you may accidentally trash your datas (docker volumes mounted for the postgres database, redis cache...).

Separate the misskey code (git clone...) from you container's volumes, something like this should do:

/usr/local/misskey/code
/usr/local/misskey/data

You will need a custom yaml file for docker-compose, but it's worth it (see sample yaml file).

Manage your misskey instance containers with docker-compose and the right path for code and datas:

docker-compose --project-directory=/usr/local/misskey/data -f /usr/local/misskey/data/<your custom docker-compose>.yml 

Quickly adjust misskey defaults settings

This particular setting in your instance configuration yaml in the .config/default.yml file will raises an error when federating with some (secured) mastodon instances, it's not trivial to find out, activate it to avoid such errors:

signToActivityPubGet: true

Arm64 specific

Deploying your misskey instance on arm64 using docker is pretty straightforward, you will need to use some generic flavor of docker images instead of specific/pined version from the original docker-compose.yml file (see the exemple yaml file in this repository).



Scripts list:

backup_postgres.sh

A daily backup for your docker postgresql database, run it daily It will cycle with the day of week (1..7) Add it to your crontab, when your instances has its lowest activity, ex: 0 5 * * * /usr/local/bin/backup_postgres.sh

cleanup_docker.sh

Prune all orphaned images, and stopped containers

get_container_id.sh

Get container ID from name (used in other scripts)



Ressources list:

misskey-arm64.yml:

A docker-compose yaml file, for an arm64 (raspberry pi, VPS arm instances)

Yolk__bad-blood__custom-emojis.zip:

Yolk emojis, from Bad-blood on Devianart. This zip file is ready to be imported on misskey (files with names and tags).