TheDude
/
openproject
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
OpenProject is the leading open source project management software.
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.
53431 Commits
139 Branches
203 Tags
1.2 GiB
Tag: Branch: Tree: 5320492816
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '5320492816'
${ noResults }
openproject/docs/operations/backup/packaged/backup.md

87 lines
2.5 KiB
Raw Normal View History Unescape

Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
# Backup your OpenProject installation
Update backup.md [ci skip]
6 years ago
**Note:** this guide only applies if you've installed OpenProject using our DEB/RPM packages.
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
Update backup.md [ci skip]
6 years ago
We advise to backup your OpenProject installation regularly — especially before upgrading to a newer version.
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
## What should be backed up
In general the following parts of your OpenProject installation should be backed up:
Update backup.md [ci skip]
6 years ago
- Data stored in the database
- Configuration files
- Uploaded files (attachments)
- Repositories (typically subversion) if applicable
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
## How to backup
The DEB/RPM packages provide a backup tool which can be used to take a snaphsot
of the current OpenProject installation. This tool will create a backup of
all parts mentioned above. The backup tool is used by executing the following
command:
Update backup.md [ci skip]
6 years ago
```
sudo openproject run backup
```
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
The command will create backup files in the following location on your system
Update backup.md [ci skip]
6 years ago
```
/var/db/openproject/backup
```
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
Apply documentation from https://github.com/opf/openproject/pull/7741
5 years ago
The content of that directory should look very similar to the following (depending on your used database, you will see a postgresql-dump-<pgdump>` file).
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
```bash
root@test-packager-backup:/opt/openproject# ls -l /var/db/openproject/backup/
total 24
-rw-r----- 1 openproject openproject 117 Apr 8 09:55 attachments-20150408095521.tar.gz
-rw-r----- 1 openproject openproject 667 Apr 8 09:55 conf-20150408095521.tar.gz
Apply documentation from https://github.com/opf/openproject/pull/7741
5 years ago
-rw-r----- 1 openproject openproject 8298 Apr 8 09:55 postgresql-dump-20150408095521.sql.gz
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
-rw-r----- 1 openproject openproject 116 Apr 8 09:55 svn-repositories-20150408095521.tar.gz
```
Update backup.md [ci skip]
6 years ago
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
## How to restore
The backup created with the tool consists of four parts
Update backup.md [ci skip]
6 years ago
which are all compressed using `gzip`. Except the database dump these parts
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
can be restored by decompressing the `*.tar.gz` files and copy the content to the
proper location. The command to untar and unzip the `*.tar.gz` files looks like
this (using sample file names from above):
```bash
tar vxfz attachments-20150408095521.tar.gz
```
Update backup.md [ci skip]
6 years ago
### Database
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
The `<dbuser>`, `<dbhost>` and `<dbname>` variables have to be replaced with
the values that are container in the `DATABASE_URL` setting of your
installation. This setting can be seen by running:
Update backup.md [ci skip]
6 years ago
```
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
openproject config:get DATABASE_URL
Apply documentation from https://github.com/opf/openproject/pull/7741
5 years ago
#=> e.g.: postgresql://dbusername:dbpassword@dbhost:dbport/dbname
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
```
Update backup.md [ci skip]
6 years ago
#### PostgreSQL
To restore the PostgreSQL dump please use the `pg_restore` command utilities.
```bash
pg_restore -h <dbhost> -u <dbuser> -W <dbname>
```
First the dump has to be extracted (unzipped) and then restored. The command
used should look very similar to this: