Skip to content

Commit f3ff1e4

Browse files
Merge pull request #144 from vshn/extend/forgejo-docs
Add forgejo backup and restore docs
2 parents 5969f6b + 291dc48 commit f3ff1e4

File tree

4 files changed

+52
-0
lines changed

4 files changed

+52
-0
lines changed

docs/modules/ROOT/nav.adoc

+3
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,10 @@
1313
1414
.Forgejo
1515
* xref:vshn-managed/forgejo/index.adoc[On cloudscale.ch]
16+
** xref:vshn-managed/forgejo/backup.adoc[Backup]
1617
** xref:vshn-managed/forgejo/create.adoc[Creation]
18+
** xref:vshn-managed/forgejo/maintenance.adoc[]
19+
** xref:vshn-managed/forgejo/restore.adoc[Restore]
1720
1821
.Kafka
1922
* xref:exoscale-dbaas/kafka/index.adoc[On Exoscale]
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
= Backups
2+
3+
Backups are enabled by default. The Forgejo instance will be backed up daily at a randomly chosen time between 22:00 and 4:00.
4+
5+
You can specify a different backup time and interval using the following backup configuration:
6+
7+
[source,yaml]
8+
----
9+
apiVersion: vshn.appcat.vshn.io/v1
10+
kind: VSHNForgejo
11+
metadata:
12+
name: forgejo-app1-prod
13+
namespace: <your-namespace>
14+
spec:
15+
parameters:
16+
...
17+
backup:
18+
schedule: 0 22 * * * <1>
19+
...
20+
----
21+
<1> The schedules for your backups.
22+
23+
NOTE: The backup relies on `forgejo dump` which collects all the data into a single archive, including the database.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
= Scheduled Maintenance
2+
3+
By default, there will be a security maintenance on Tuesday night (Central Europe Time).
4+
5+
The day and time can be adjusted as described below. Times are in the CET time zone.
6+
7+
.Nexcloud instance with custom maintenance
8+
[source,yaml]
9+
----
10+
apiVersion: vshn.appcat.vshn.io/v1
11+
kind: VSHNForgejo
12+
metadata:
13+
name: forgejo-app1-prod
14+
namespace: prod-app
15+
spec:
16+
parameters:
17+
maintenance:
18+
dayOfWeek: wednesday # <1>
19+
timeOfDay: '23:30:00' # <2>
20+
----
21+
<1> The day when the maintenance should take place
22+
<2> The time when the maintenance should be started
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
= Restores
2+
3+
Self-service restores aren't implemented yet.
4+
If you need to restore Forgejo please contact our mailto:[email protected][Support].

0 commit comments

Comments
 (0)