add backups

.gitea/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,16 @@
+---
+name: "Shlink pull request template"
+about: "Shlink pull request template"
+---
+
+<!-- 
+Thank you for doing recipe maintenance work!
+Please mark all checklist items which are relevant for your changes.
+Please remove the checklist items which are not relevant for your changes.
+Feel free to remove this comment.
+-->
+
+* [ ] I have deployed and tested my changes
+* [ ] I have [updated relevant versions in `abra.sh`](https://docs.coopcloud.tech/maintainers/upgrade/#updating-versions-in-the-abrash)
+* [ ] I have made my environment variable changes [backwards compatible](https://docs.coopcloud.tech/maintainers/upgrade/#backwards-compatible-environment-variable-changes)
+* [ ] I have added a [release note entry](https://docs.coopcloud.tech/maintainers/upgrade/#creating-new-release-notes)

.gitignore

@@ -1 +1,2 @@
 .envrc
+*~

MAINTENANCE.md

@@ -0,0 +1,32 @@
+# Shlink Recipe Maintenance
+
+All contributions should be made via a pull request. This is to ensure a
+certain quality and consistency, that others can rely on.
+
+## Maintainer Responsibilities
+
+A recipe maintainer has the following responsibilities:
+
+- Respond to pull requests / issues within a week
+- Make image security updates within a day
+- Make image patch / minor updates within a week
+- Make image major updates within a month
+
+In order to fullfill these responsibilities a recipe maintainer:
+
+- Has to watch the repository (to get notifications)
+- Needs to make sure renovate is configured properly
+
+## Pull Requests
+
+A pull request can be merged if it is approved by at least one maintainer. For
+pull requests opened by a maintainer they need to be approved by another
+maintainer. Even though it is okay to merge a pull request with one approval, it
+is always better if all maintainers looked at the pull request and approved it.
+
+## Become a maintainer
+
+Everyone can apply to be a recipe maintainer:
+1. Watch the repository to always get updates
+2. Simply add your self to the list in the [README.md](./README.md) and open a new pull request with the change.
+3. Once the pull request gets merged you will be added to the [shlink maintainers team](https://git.coopcloud.tech/org/coop-cloud/teams/shlink-maintainers).

README.md

@@ -1,18 +1,18 @@
 # shlink
 
-> One line description of the recipe
+> Shlink is a self-hosted url shortner.
 
 <!-- metadata -->
 
 * **Category**: Apps
-* **Status**: 0
+* **Status**: 2
 * **Image**: [`shlink`](https://hub.docker.com/r/shlink), 4, upstream
 * **Healthcheck**: No
-* **Backups**: No
+* **Backups**: Yes
 * **Email**: No
 * **Tests**: No
 * **SSO**: No
-* **Maintainers**: RTM - POC: `@ammaratef45:matrix.org`
+* **Maintainers**: [@Zigzagill](https://git.coopcloud.tech/Zigzagill), [@ammaratef45](https://git.coopcloud.tech/ammaratef45)
 
 <!-- endmetadata -->
 
@@ -29,4 +29,4 @@ For more, see [`docs.coopcloud.tech`](https://docs.coopcloud.tech).
 
 The recipe will deploy a `console.<app-name>` as well that you can use to manage and monitor short urls.
 
-To do so, you will need an api-key, which you can create by using the `./bin/cli api-key:generate`.
+To do so, you will need an api-key, which you can create by using the `./bin/cli api-key:generate`.

abra.sh

@@ -0,0 +1,49 @@
+#!/bin/bash
+
+list_api_keys() {
+    shlink api-key:list
+}
+
+generate_api_key() {
+    # TODO: add --expiration-date (optionally)?
+    KEY_NAME=$1
+
+    echo "Generating new key..."
+    if [ -z "$KEY_NAME" ]; then
+        shlink api-key:generate
+        return
+    fi
+
+    shlink api-key:generate --name $KEY_NAME
+}
+
+rename_api_key() {
+    OLD_NAME=$1
+    NEW_NAME=$2
+
+    if [ -z "$OLD_NAME" ]; then
+        echo "No key name(s) provided!"
+        return
+    fi
+
+    if [ -z "$NEW_NAME" ]; then
+        echo "New key name not provided!"
+        return
+    fi
+
+    echo "Renaming key..."
+
+    shlink api-key:rename $OLD_NAME $NEW_NAME
+}
+
+disable_api_key() {
+    KEY_NAME=$1
+
+    if [ -z "$KEY_NAME" ]; then
+        echo "Key name not provided!"
+    fi
+
+    echo "Disabling key..."
+
+    shlink api-key:disable --by-name $KEY_NAME
+}

compose.yml

@@ -21,6 +21,7 @@ services:
         - "traefik.http.routers.${STACK_NAME}.entrypoints=web-secure"
         - "traefik.http.routers.${STACK_NAME}.tls.certresolver=${LETS_ENCRYPT_ENV}"
         - "coop-cloud.${STACK_NAME}.version=0.2.0+4.4"
+        - "backupbot.backup=true"
   web:
     image: shlinkio/shlink-web-client:4.5.1
     networks:

renovate.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:recommended"
+  ],
+  "reviewers": [
+    "team:shlink-maintainers"
+  ]
+}