Skip to content

Commit 720ee34

Browse files
authored
Merge pull request #3 from ABCD-DEVCOM/documentation-3.3.x
Archives version 3.2.x documentation and creates version 3.3.x structure
2 parents 0591663 + 486a198 commit 720ee34

File tree

1,135 files changed

+15912
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,135 files changed

+15912
-1
lines changed

docusaurus.config.js

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,20 @@ const config = {
6666

6767
versions: {
6868
current: {
69-
label: '3.2.X', // O nome no menu dropdown
69+
label: '3.3.X', // O nome no menu dropdown
7070
path: '', // <--- O TRUQUE: Deixar vazio remove o prefixo da URL
7171
banner: 'none', // Remove o aviso de "versão não lançada"
7272
},
73+
'3.2': {
74+
label: '3.2.x',
75+
path: '3.2',
76+
banner: 'none',
77+
},
78+
'2.0': {
79+
label: '2.0.x',
80+
path: '2.0',
81+
banner: 'none',
82+
},
7383
},
7484

7585
// Outras configurações visuais úteis
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Database Architecture and Administration",
3+
"position": 6,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Everything a system administrator needs to know to keep ABCD running."
7+
}
8+
}
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Access Management",
3+
"position": 4,
4+
"link": {
5+
"type": "doc",
6+
"id": "index"
7+
}
8+
}
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Access Management Overview
3+
sidebar_label: Access Management
4+
---
5+
6+
# Access Management
7+
8+
Security in ABCD is controlled by a relationship between **Operators** (who logs in) and **Profiles** (what they can do). This section guides administrators through configuring secure access to the system.
9+
10+
## Core Concepts
11+
12+
### 1. Profiles (Authorization)
13+
Profiles act as templates for permissions. Instead of assigning rights to each user individually, you define a role (e.g., "Cataloger", "Loan Officer") and assign users to that role.
14+
* **[Manage Profiles](profiles.md)**: Learn how to create and edit permission sets.
15+
16+
### 2. Operators (Authentication)
17+
Operators are the actual user accounts. Each operator must be assigned to a valid profile to access the system.
18+
* **[Manage Operators](operators.md)**: Learn how to create users, reset passwords, and restrict access by library branch.
19+
20+
:::tip Security Best Practice
21+
Avoid using the generic `adm` or `abcd` accounts for daily work. Create individual accounts for every staff member to ensure actions can be traced back to a specific person in the system logs.
22+
:::
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: User Management
3+
sidebar_label: User Management
4+
---
5+
6+
# User Management
7+
8+
Effective user management is essential for system security. In ABCD, access control is managed via two interacting components: **Operators** (the people) and **Profiles** (the permissions).
9+
10+
All user data is stored in the `acces` database.
11+
12+
## 1. Access Profiles
13+
14+
Before creating users, you must define what they can do. Profiles act as templates for permissions.
15+
16+
* **Path:** **Central > Administration > User administration > Create/edit profiles**
17+
18+
Instead of assigning permissions to each person individually, you create a profile (e.g., `loan_operator`) and assign it to multiple users. If you update the profile, all associated users are updated instantly.
19+
20+
:::tip Strategy
21+
Create strict profiles. It is better to have a `cataloger` profile that *only* accesses the Cataloging module than to give everyone the `adm` (Administrator) profile.
22+
:::
23+
24+
## 2. Managing Operators
25+
26+
Operators are the individual accounts used to log in to the system.
27+
28+
* **Path:** **Central > Administration > User administration > User administration**
29+
30+
### Creating a New Operator
31+
32+
To create a new account, click **New user** and complete the following fields:
33+
34+
#### Essential Fields
35+
* **Username**: The login ID. Case sensitive (e.g., `maria`). **Avoid spaces or special characters.**
36+
* **Full name**: The real name of the staff member (e.g., `Maria Silva`).
37+
* **Profile**: Select the authorization level defined in the previous step.
38+
* **Password**: Define the initial password.
39+
* **Confirm password**: Retype to validate.
40+
41+
#### Advanced Configuration
42+
* **Library Code**: Critical for multi-branch libraries. Restricts the operator to managing copies owned by a specific branch (e.g., `MAIN`, `MED`).
43+
* **Cataloger Code**: A short code (e.g., `MS`) recorded in the database logs (typically field 900) to audit who created or modified a record.
44+
* **Expiration Date**: YYYYMMDD format. The account effectively locks after this date. Useful for temporary staff or students.
45+
46+
### Maintenance Tasks
47+
48+
* **Reset Password**: If a user forgets their password, edit their record here. You cannot see the old password (it is encrypted), but you can overwrite it with a new one.
49+
* **Deactivate User**: To remove access without losing the history of records created by that user, set an **Expiration Date** in the past (do not delete the record unless necessary).
50+
51+
:::danger Security Best Practice
52+
Never share the generic `abcd` or `adm` accounts. Every staff member must have their own named account to ensure accountability in the system logs.
53+
:::
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Profiles and Permissions
3+
sidebar_label: Profiles & Permissions
4+
sidebar_position: 3
5+
---
6+
7+
# Profiles and Permissions
8+
9+
In ABCD, permissions are not defined checkbox-by-checkbox for every user. Instead, you define **Profiles** (Roles), and assign users to these profiles.
10+
11+
## How Profiles Work
12+
A profile is essentially a list of authorized system functions. If a function is not listed in the profile, the menu option will not appear for that user.
13+
14+
Common examples of profiles included by default:
15+
* **`adm` (System Administrator):** Has access to everything, including file editing and database creation.
16+
* **`dbadmin` (Database Administrator):** Can manage database structures (FDT/FST) but cannot change system core files.
17+
* **`operator` (Cataloger):** Can search and edit records but cannot delete databases or change structures.
18+
* **`loan` (Circulation):** Can only access the Loan module.
19+
20+
## creating or Editing a Profile
21+
1. Go to **Administration > User administration**.
22+
2. Click on **Create/edit profiles**.
23+
24+
### The Profile Editor
25+
The editor shows a tree view of all available system functions.
26+
27+
1. **Select a Profile:** Choose an existing one to edit or type a new name to create one.
28+
2. **Grant Permissions:**
29+
* Browse the tree structure.
30+
* **Check** the boxes for the modules and functions this profile should access.
31+
* *Example:* For a "Student Assistant", you might only check **Cataloging > Data Entry** and uncheck everything else.
32+
3. **Save:** Click the save button to write the changes to the profile file.
33+
34+
:::tip File Location
35+
Profiles are physically stored as text files in `bases/par/profiles/`. Advanced users can edit these files directly to create highly granular restrictions.
36+
:::
Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
---
2+
title: Backup and Restore
3+
sidebar_label: Backup & Restore
4+
sidebar_position: 8
5+
description: Strategies for data preservation, including the Backup Manager tool, ISO 2709 exports, and file-system backups.
6+
---
7+
import Video from '@site/src/components/Video';
8+
9+
# Backup and Restore Strategies
10+
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.
12+
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.
44+
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.
50+
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)
66+
1. Navigate to **Utilities > Export/Import > Export ISO**.
67+
2. Select the Database.
68+
3. **Parameters**:
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.
72+
4. Click **Export**.
73+
5. Download the resulting `.iso` file to your local machine.
74+
75+
### Importing from ISO (Restore)
76+
To restore data or migrate from another system:
77+
78+
1. Navigate to **Utilities > Export/Import > Import ISO**.
79+
2. **Upload** your `.iso` file to the server.
80+
3. Select the target Database.
81+
4. **Options**:
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.
84+
5. Click **Import**.
85+
86+
:::warning Data Loss Risk
87+
Using the "Create" option will delete all existing records in the selected database. Ensure you have a backup before proceeding.
88+
:::
89+
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.
95+
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:
97+
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.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: The Database Registry (bases.dat)
3+
sidebar_label: The Registry (bases.dat)
4+
sidebar_position: 3
5+
---
6+
7+
# The Database Registry (bases.dat)
8+
9+
Unlike some modern systems that automatically scan folders, ABCD requires you to explicitly "register" a database for it to appear in the selection menu. This registry is a plain text file named **`bases.dat`**.
10+
11+
**Location:** `bases/bases.dat`
12+
13+
## File Structure
14+
15+
The file is a simple list where each line represents a database available in the system. The syntax relies on a pipe character (`|`) as a separator between the internal folder name and the public label.
16+
17+
```text
18+
folder_name|Description displayed in menu

0 commit comments

Comments
 (0)