Skip to content

Commit

Permalink
docs: add clickable hyperlinks
Browse files Browse the repository at this point in the history
  • Loading branch information
Actionb committed Sep 30, 2024
1 parent 7c63f5d commit e004a3c
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 24 deletions.
28 changes: 16 additions & 12 deletions dbentry/site/templates/help/verwaltung.html
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,8 @@ <h4 id="cronjob">Cronjob</h4>
<h4 id="rclone">rclone</h4>
<p>Mit rclone sync und cronjob kann das Hochladen der Backups auf ein Google Drive automatisiert werden.</p>
<ol>
<li>rclone installieren: https://rclone.org/install/</li>
<li>rclone für Google Drive konfigurieren: https://rclone.org/drive/</li>
<li>rclone installieren: <a href="https://rclone.org/install/">https://rclone.org/install/</a></li>
<li>rclone für Google Drive konfigurieren: <a href="https://rclone.org/drive/">https://rclone.org/drive/</a></li>
<li>crontab öffnen:
<code>shell
sudo crontab -e</code>
Expand All @@ -100,17 +100,18 @@ <h4 id="rclone">rclone</h4>
53 7,11,16 * * 1-5 rclone --config=/path/to/rclone.conf sync /path/to/mizdb/backups &lt;remote_name&gt;:backups</code></li>
</ol>
<p>Die Standardkonfiguration erfordert einen Webbrowser.
Um rclone ohne Webbrowser (z.B. für einen headless Server) zu konfigurieren: https://rclone.org/remote_setup/</p>
Um rclone ohne Webbrowser (z.B. für einen headless Server) zu
konfigurieren: <a href="https://rclone.org/remote_setup/">https://rclone.org/remote_setup/</a></p>
<h5 id="rclone-mit-google-service-account">rclone mit Google Service Account</h5>
<p>Alternativ kann über einen Service Account auf den Backup-Ordner zugegriffen werden:</p>
<p>https://rclone.org/drive/#service-account-support</p>
<p><a href="https://rclone.org/drive/#service-account-support">https://rclone.org/drive/#service-account-support</a></p>
<p>Als Beispiel, Upload zum existierenden Backup-Drive auf mizdbbackup@gmail.com:</p>
<ol>
<li>
<p>Falls nicht der bereits existierende Service "dbbackup-service" benutzt werden soll, muss
vorerst ein Service Account angelegt werden:</p>
<ol>
<li>in die Google Cloud Console einloggen: https://console.cloud.google.com</li>
<li>in die Google Cloud Console einloggen: <a href="https://console.cloud.google.com">https://console.cloud.google.com</a></li>
<li>Service Accounts &gt; Create Service Account</li>
<li>im Drive Ordner rechts in den Ordnerdetails unter "Zugriff verwalten" den Backup-Ordner für den neuen Service
Account freigeben</li>
Expand All @@ -119,7 +120,7 @@ <h5 id="rclone-mit-google-service-account">rclone mit Google Service Account</h5
<li>
<p>Service Account Key (<code>credentials.json</code>) generieren, falls nicht vorhanden:</p>
<ol>
<li>in die Google Cloud Console einloggen: https://console.cloud.google.com</li>
<li>in die Google Cloud Console einloggen: <a href="https://console.cloud.google.com">https://console.cloud.google.com</a></li>
<li>Service Accounts &gt; dbbackup-service &gt; KEYS</li>
<li>Mit "ADD KEY" wird ein neuer Key erzeugt und heruntergeladen</li>
</ol>
Expand All @@ -129,26 +130,29 @@ <h5 id="rclone-mit-google-service-account">rclone mit Google Service Account</h5
<ol>
<li>In Google Drive einloggen</li>
<li>Unter "Meine Ablage" den entsprechenden Ordner anklicken</li>
<li>die ID ist am Ende der URL nach <code>/folders/</code> zu finden; also
z.B. https://drive.google.com/drive/u/1/folders/10z55r6HFxfOWkmrRIT4-mrjhhJgqYPqa hat die
ID <code>10z55r6HFxfOWkmrRIT4-mrjhhJgqYPqa</code></li>
<li>die ID ist am Ende der URL nach <code>/folders/</code> zu finden;<br/>
also z.B. <code>https://drive.google.com/drive/u/1/folders/foo1bar</code> hat die ID <code>foo1bar</code></li>
</ol>
</li>
<li>
<p>rclone Konfigurationsdatei erzeugen: https://rclone.org/drive/#service-account-support</p>
<p>rclone Konfigurationsdatei
erzeugen: <a href="https://rclone.org/drive/#service-account-support">https://rclone.org/drive/#service-account-support</a></p>
</li>
</ol>
<p>Mit einer solchen rclone.conf, zu finden unter <code>/home/my_user/.config/rclone/</code>:</p>
<pre><code>[dbbackup]
type = drive
scope = drive
root_folder_id = 10z55r6HFxfOWkmrRIT4-mrjhhJgqYPqa
root_folder_id = foo1bar
service_account_file = /pfad/zu/service/account/credentials.json
</code></pre>
<p>müsste der cronjob so aussehen:</p>
<pre><code>53 7,11,16 * * 1-5 rclone --config=/home/my_user/.config/rclone/rclone.conf sync /var/lib/mizdb/backups dbbackup:/
</code></pre>
<p>Weitere Links: <a href="https://forum.rclone.org/t/gdrive-access-via-service-account/17926">Gdrive access via service account</a></p>
<p>Weitere Links:</p>
<ul>
<li><a href="https://forum.rclone.org/t/gdrive-access-via-service-account/17926">Gdrive access via service account</a></li>
</ul>
<h3 id="update">Update</h3>
<p>Um die Anwendung zu aktualisieren, benutze:</p>
<pre><code class="language-shell">bash mizdb.sh update
Expand Down
27 changes: 15 additions & 12 deletions docs/docs/verwaltung.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ Und folgenden cronjob hinzufügen:

Mit rclone sync und cronjob kann das Hochladen der Backups auf ein Google Drive automatisiert werden.

1. rclone installieren: https://rclone.org/install/
2. rclone für Google Drive konfigurieren: https://rclone.org/drive/
1. rclone installieren: [https://rclone.org/install/](https://rclone.org/install/)
2. rclone für Google Drive konfigurieren: [https://rclone.org/drive/](https://rclone.org/drive/)
3. crontab öffnen:
```shell
sudo crontab -e
Expand All @@ -82,44 +82,45 @@ Mit rclone sync und cronjob kann das Hochladen der Backups auf ein Google Drive
```

Die Standardkonfiguration erfordert einen Webbrowser.
Um rclone ohne Webbrowser (z.B. für einen headless Server) zu konfigurieren: https://rclone.org/remote_setup/
Um rclone ohne Webbrowser (z.B. für einen headless Server) zu
konfigurieren: [https://rclone.org/remote_setup/](https://rclone.org/remote_setup/)

##### rclone mit Google Service Account

Alternativ kann über einen Service Account auf den Backup-Ordner zugegriffen werden:

https://rclone.org/drive/#service-account-support
[https://rclone.org/drive/#service-account-support](https://rclone.org/drive/#service-account-support)

Als Beispiel, Upload zum existierenden Backup-Drive auf mizdbbackup@gmail.com:

1. Falls nicht der bereits existierende Service "dbbackup-service" benutzt werden soll, muss
vorerst ein Service Account angelegt werden:
1. in die Google Cloud Console einloggen: https://console.cloud.google.com
1. in die Google Cloud Console einloggen: [https://console.cloud.google.com](https://console.cloud.google.com)
2. Service Accounts > Create Service Account
3. im Drive Ordner rechts in den Ordnerdetails unter "Zugriff verwalten" den Backup-Ordner für den neuen Service
Account freigeben

2. Service Account Key (`credentials.json`) generieren, falls nicht vorhanden:
1. in die Google Cloud Console einloggen: https://console.cloud.google.com
1. in die Google Cloud Console einloggen: [https://console.cloud.google.com](https://console.cloud.google.com)
2. Service Accounts > dbbackup-service > KEYS
3. Mit "ADD KEY" wird ein neuer Key erzeugt und heruntergeladen

3. Root Folder ID des Backup-Ordners herausfinden:
1. In Google Drive einloggen
2. Unter "Meine Ablage" den entsprechenden Ordner anklicken
3. die ID ist am Ende der URL nach `/folders/` zu finden; also
z.B. https://drive.google.com/drive/u/1/folders/10z55r6HFxfOWkmrRIT4-mrjhhJgqYPqa hat die
ID `10z55r6HFxfOWkmrRIT4-mrjhhJgqYPqa`
3. die ID ist am Ende der URL nach `/folders/` zu finden;
also z.B. `https://drive.google.com/drive/u/1/folders/foo1bar` hat die ID `foo1bar`

4. rclone Konfigurationsdatei erzeugen: https://rclone.org/drive/#service-account-support
4. rclone Konfigurationsdatei
erzeugen: [https://rclone.org/drive/#service-account-support](https://rclone.org/drive/#service-account-support)

Mit einer solchen rclone.conf, zu finden unter `/home/my_user/.config/rclone/`:

```
[dbbackup]
type = drive
scope = drive
root_folder_id = 10z55r6HFxfOWkmrRIT4-mrjhhJgqYPqa
root_folder_id = foo1bar
service_account_file = /pfad/zu/service/account/credentials.json
```

Expand All @@ -129,7 +130,9 @@ müsste der cronjob so aussehen:
53 7,11,16 * * 1-5 rclone --config=/home/my_user/.config/rclone/rclone.conf sync /var/lib/mizdb/backups dbbackup:/
```

Weitere Links: [Gdrive access via service account](https://forum.rclone.org/t/gdrive-access-via-service-account/17926)
Weitere Links:

* [Gdrive access via service account](https://forum.rclone.org/t/gdrive-access-via-service-account/17926)

### Update

Expand Down

0 comments on commit e004a3c

Please sign in to comment.