Backup
Requires backing up both the file system and the database.
File system backup
The following is a summary of folders to back up:
| Folder (Linux) | Contents | Backup instruction |
|---|---|---|
/opt/pageseeder/documents | The source of all non-PSML documents | Required simultaneously with database backup |
/opt/pageseeder/WEB-INF/config | A PageSeeder configuration including properties and templates | Required |
/opt/pageseeder/WEB-INF/state | Indexes, logs, caches and temporary files | Recommended (publish can be excluded) |
Documents
The documents folder holds the source files for most documents and must be regularly backed up. To ensure consistency, the backup must be performed simultaneously with the database backup, ensuring that database references to the files remain accurate.
As the documents folder can contain a large number of files and grows over time, it's important to factor this into your capacity planning and management strategy.
If the database and documents folder are not backed up simultaneously, some documents might become dereferenced or reported as missing by PageSeeder.
Config
The config folder must be backed up as it contains all files specific to your PageSeeder installation.
Although they do not change frequently, we recommend backing them up alongside other backups.
State
Files in the state folder are highly volatile and grow over time. All files in this folder are generated by PageSeeder and are not critical for disaster recovery.
While most files can be regenerated, the state folder contains important files that are essential for PageSeeder’s functionality and performance:
-
Indexes: These enable searching and related functions. If lost, PageSeeder administrators need to rebuild them using the administration interface. For installations with many documents or comments, the indexing process can take several hours, delaying full functionality.
-
Caches: These files are automatically regenerated as the system is used. However, their loss can impact performance and degrade the user experience. PageSeeder must be stopped to backup the
ehcachefiles which include the PSML documents cache. -
Logs: While not necessary for PageSeeder to function, logs might need to be retained for regulatory compliance. Therefore, they generally need be backed up as part of your retention strategy.
The publish folder contains only temporary files and can be safely excluded from backups.