diff --git a/README.md b/README.md index 745b875..7c38b66 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,12 @@ # misskey-admin-scripts-n-tips -A collection of scripts and tips to make a Misskey admin's life a little bit easyer +A collection of scripts and tips to make a Misskey admin's life a little bit easyer. -Abstract: a VPS, Docker, a Misskey instance, what could save you some time ? +It is a complement to the [official documentation](https://misskey-hub.net/en/docs/install/docker.html). -# Scripts list: +Abstract: a VPS with arm64 processor, Docker, a Misskey instance, what could save you some time ? -## backup_postgres.sh -A daily backup for your docker postgresql database, run it daily -It will cycle with the day of week (1..7) - -## cleanup_docker.sh -Prune all orphaned images, and stopped containers - -## get_container_id.sh -Get container ID from name (used in other scripts) +--- # Tips list: @@ -35,6 +27,35 @@ Manage your misskey instance containers with docker-compose and the right path f docker-compose --project-directory=/usr/local/misskey/data -f /usr/local/misskey/data/.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: @@ -43,4 +64,4 @@ 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](https://www.deviantart.com/bad-blood/art/Y-o-l-k-s-78118255). This zip file is ready to be imported on misskey (files with names and tags) +Yolk emojis, from [Bad-blood on Devianart](https://www.deviantart.com/bad-blood/art/Y-o-l-k-s-78118255). This zip file is ready to be imported on misskey (files with names and tags).