kanbanworkflowstimelinescrumrubyroadmapproject-planningproject-managementopenprojectangularissue-trackerifcgantt-chartganttbug-trackerboardsbcf
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
74 lines
2.7 KiB
74 lines
2.7 KiB
---
|
|
sidebar_navigation:
|
|
title: Backing up
|
|
priority: 9
|
|
---
|
|
|
|
# Backing up your OpenProject installation
|
|
|
|
We advise to backup your OpenProject installation regularly — especially before upgrading to a newer version.
|
|
|
|
## What should be backed up
|
|
|
|
In general the following parts of your OpenProject installation should be backed up:
|
|
|
|
- Data stored in the database
|
|
- Configuration files
|
|
- Uploaded files (attachments)
|
|
- Repositories (subversion, git) if applicable
|
|
|
|
## Package-based installation (DEB/RPM)
|
|
|
|
The DEB/RPM packages provide a backup tool which can be used to take a snapshot
|
|
of the current OpenProject installation. This tool will create a backup of
|
|
all parts mentioned above. The backup tool is invoked by executing the following
|
|
command:
|
|
|
|
```bash
|
|
sudo openproject run backup
|
|
```
|
|
|
|
The command will create backup files in the following location on your system:
|
|
|
|
```bash
|
|
/var/db/openproject/backup
|
|
```
|
|
|
|
The content of that directory should look very similar to the following (depending on your database engine, you will see either a `mysql-dump-<date>.sql.gz` or a `postgresql-dump-<date>.pgdump` file).
|
|
|
|
```bash
|
|
root@ip-10-0-0-228:/home/admin# ls -al /var/db/openproject/backup/
|
|
total 1680
|
|
drwxr-xr-x 2 openproject openproject 4096 Nov 19 21:00 .
|
|
drwxr-xr-x 6 openproject openproject 4096 Nov 19 21:00 ..
|
|
-rw-r----- 1 openproject openproject 1361994 Nov 19 21:00 attachments-20191119210038.tar.gz
|
|
-rw-r----- 1 openproject openproject 1060 Nov 19 21:00 conf-20191119210038.tar.gz
|
|
-rw-r----- 1 openproject openproject 126 Nov 19 21:00 git-repositories-20191119210038.tar.gz
|
|
-rw-r----- 1 openproject openproject 332170 Nov 19 21:00 postgresql-dump-20191119210038.pgdump
|
|
-rw-r----- 1 openproject openproject 112 Nov 19 21:00 svn-repositories-20191119210038.tar.gz
|
|
```
|
|
|
|
You should then copy those dump files to a secure location, for instance an S3 bucket or some sort of backup server.
|
|
|
|
## Docker-based installation
|
|
|
|
TODO: review
|
|
|
|
If you've followed the steps described in the [installation guide for Docker](../../installation/docker),
|
|
then you just need to make a backup of the exported volumes, at your
|
|
convenience. As a reminder, here is the recommended way to launch OpenProject
|
|
with Docker:
|
|
|
|
```bash
|
|
sudo mkdir -p /var/lib/openproject/{pgdata,logs,static}
|
|
|
|
docker run -d -p 8080:80 --name openproject -e SECRET_KEY_BASE=secret \
|
|
-v /var/lib/openproject/pgdata:/var/lib/postgresql/9.6/main \
|
|
-v /var/lib/openproject/logs:/var/log/supervisor \
|
|
-v /var/lib/openproject/static:/var/db/openproject \
|
|
openproject/community:10
|
|
```
|
|
|
|
If you're using the same local directories than the above command, then you
|
|
just need to backup your local `/var/lib/openproject` folder (for instance to
|
|
S3 or FTP).
|
|
|