Skip to content

Commit 0591663

Browse files
committed
Expands documentation on the backup system
1 parent b881d9f commit 0591663

File tree

2 files changed

+71
-18
lines changed

2 files changed

+71
-18
lines changed

docs/abcd-administration/backup-restore.md

Lines changed: 71 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,47 +2,100 @@
22
title: Backup and Restore
33
sidebar_label: Backup & Restore
44
sidebar_position: 8
5+
description: Strategies for data preservation, including the Backup Manager tool, ISO 2709 exports, and file-system backups.
56
---
7+
import Video from '@site/src/components/Video';
68

79
# Backup and Restore Strategies
810

9-
Data preservation in ABCD relies on the ISO 2709 standard (for bibliographic data) and file-system backups (for configuration and documents).
11+
Data preservation in ABCD relies on multiple layers of security. You can use the built-in **Backup Manager** for quick snapshots of your environment, the **ISO 2709 standard** for bibliographic data exchange/preservation, or manual **file-system backups** for server-level redundancy.
1012

11-
## Exporting to ISO (Backup)
13+
---
14+
15+
## 1. The Backup Manager (New)
16+
17+
The **Backup Manager** is a built-in tool introduced in recent versions that allows system administrators to create compressed backups (`.zip`) of the database structures and records directly from the administrative interface.
18+
19+
### Accessing the Tool
20+
1. Go to the **System Configuration** menu (Central Module).
21+
2. Click on **Backups**.
22+
23+
<Video src="https://www.youtube.com/embed/pX8h9m5SPbk" />
24+
25+
:::info
26+
You must have administrative privileges (`adm` profile) to access this tool.
27+
:::
28+
29+
### Creating a Backup
30+
The tool offers three specific backup strategies:
31+
32+
#### A. Full Backup (No Media)
33+
* **Filename tag:** `FULL_NOMEDIA`
34+
* **Includes:** All databases found in the `bases/` directory.
35+
* **Excludes:** Temporary files (`wrk/`) and digital object folders (`collection/`).
36+
* **Best for:** Routine backups. It saves all bibliographic data and structures without heavy digital files, resulting in a lightweight `.zip` file.
37+
38+
#### B. Full Backup (With Media)
39+
* **Filename tag:** `FULL_MEDIA`
40+
* **Includes:** All databases in `bases/`, **including** the `collection/` folders (digital objects).
41+
* **Excludes:** Only the `wrk/` folder.
42+
* **Best for:** Complete system snapshots including PDFs and images.
43+
* **⚠️ Warning:** Depending on your collection size, this file can be extremely large and take a long time to generate.
1244

13-
The safest way to backup an ISIS database is exporting it to an ISO 2709 file. This format is independent of the operating system (Linux/Windows).
45+
#### C. Single Database
46+
* **Filename tag:** `DB-[BASENAME]`
47+
* **Includes:** Only the folder of the specific database selected.
48+
* **Excludes:** The `collection/` folder of that specific base.
49+
* **Best for:** When you have made changes to a specific database definition or want to export a single set of records.
1450

15-
### Via Central Module
51+
### Operating System Detection
52+
Since ABCD uses ISIS database technology, files generated on Windows are not always compatible with Linux/Unix (due to case-sensitivity). The system automatically adds a prefix to the filename:
53+
* **`Win_`**: Created on a **Windows** server.
54+
* **`Lin_`**: Created on a **Linux/Unix** server.
55+
56+
### Managing Backups
57+
The tool lists all available backups stored on the server (in `/bases/wrk/backups/`). You can **Download** them to your local computer or **Delete** them to save server space.
58+
59+
---
60+
61+
## 2. ISO 2709 Export/Import (Standard)
62+
63+
While the Backup Manager zips the physical files, the **ISO 2709** format is the international standard for bibliographic data interchange. This is the safest way to migrate data between different operating systems (e.g., moving from Windows to Linux) or between different library software (e.g., Koha to ABCD).
64+
65+
### Exporting to ISO (Backup)
1666
1. Navigate to **Utilities > Export/Import > Export ISO**.
1767
2. Select the Database.
1868
3. **Parameters**:
19-
* **FST**: Usually leave blank to export all fields (or select an FST to export only indexed fields).
20-
* **Type of conversion**: ANSI or UTF-8 (depending on your target system).
21-
* **Separator**: usually `#` or another unique character.
69+
* **FST**: Usually leave blank to export all fields (or select an FST to export only indexed fields).
70+
* **Type of conversion**: ANSI or UTF-8 (depending on your target system).
71+
* **Separator**: Usually `#` or another unique character.
2272
4. Click **Export**.
2373
5. Download the resulting `.iso` file to your local machine.
2474

25-
## Importing from ISO (Restore)
26-
75+
### Importing from ISO (Restore)
2776
To restore data or migrate from another system:
2877

2978
1. Navigate to **Utilities > Export/Import > Import ISO**.
3079
2. **Upload** your `.iso` file to the server.
3180
3. Select the target Database.
3281
4. **Options**:
33-
* **Append**: Adds records to the end of the database.
34-
* **Create/New**: **Erases** the existing database and creates a new one from the ISO.
82+
* **Append**: Adds records to the end of the existing database.
83+
* **Create/New**: **Erases** the existing database and creates a new one from the ISO.
3584
5. Click **Import**.
3685

37-
:::warning
86+
:::warning Data Loss Risk
3887
Using the "Create" option will delete all existing records in the selected database. Ensure you have a backup before proceeding.
3988
:::
4089

41-
## Full System Backup
90+
---
91+
92+
## 3. Manual Server-Side Backup
93+
94+
If you are a system administrator with access to the server's file system, you may prefer to use tools like `rsync`, `tar`, or standard backup software.
4295

43-
Besides the database records, you must backup the physical files to preserve configurations, print formats, and digital documents.
96+
The **Backup Manager** (Section 1) essentially automates the zipping of the `/bases/` directory, but for a total system restoration (including the software executables), you should ensure the following directories are preserved:
4497

45-
**Directories to Backup:**
46-
* `/bases/`: Contains all data, FDTs, PFTs, and uploaded documents.
47-
* `/htdocs/central/config.php`: Main configuration file.
48-
* `/cgi-bin/*.par`: Parameter files defining database paths.
98+
* **`/bases/`**: Contains all data, FDTs, PFTs, and uploaded documents.
99+
* **`/htdocs/central/config.php`**: The main configuration file containing paths and URLs.
100+
* **`/cgi-bin/*.par`**: Parameter files defining database paths.
101+
* **`/htdocs/`**: If you have customized PHP scripts or added a custom OPAC design.
55.7 KB
Loading

0 commit comments

Comments
 (0)