Installing and upgrading
- Installation overview
- General installation requirements
- Installing on Ubuntu Linux
- Installing on Windows Server
- Installing on macOS
- Installing on CentOS Linux
- Installing via Docker
- Installing on SuSE
- Configuring php.ini
- Configuring Apache
- Configuring the database
- Upgrading
- LibreOffice integration for Microsoft Office previews
- OpenCV (facial recognition)
- Upgrading PHP versions
- Setting up scheduled tasks/cron
Backups
Security
User management
Advanced user group options
Customising ResourceSpace
Plugins
StaticSync
Configuring ResourceSpace
- The config file
- Offline job queues
- File integrity checking
- ResourceSpace file storage (filestore)
- Checksums
- Edit access for contributors
- Configuring Leaflet Maps
- Automatic alternative video files
- Signing all database PHP code
- Integrating with Uppy Companion
- The System Configuration page
- Configuring image alternatives
- Minimal preview creation
- Mounting Amazon S3 for external storage
Integrations
Installing via Docker
We now provide an official Docker image to make deploying your ResourceSpace system even easier.
The following steps assume you are using Ubuntu 24.04 as this provides the best performance, however this Docker image can be built on other operating system such as Windows and macOS.
Installation steps
Install Docker Engine on your server - ensuring the post installation steps are followed as well. Alternatively, Docker Desktop can be installed instead.
Install Git:
sudo apt update && sudo apt install git -y
Create a directory to contain the Docker files and clone the GitHub repository inside it:
git clone https://github.com/resourcespace/docker.git resourcespace
Edit the db.env file and set the MariaDB database passwords:
MYSQL_PASSWORD=change-me MYSQL_ROOT_PASSWORD=change-me MYSQL_DATABASE=resourcespace MYSQL_USER=resourcespace_rw
Build the Image:
docker compose up --build -d
Check the containers are running:
docker ps
Visit
http://localhost
in a web browser and the ResourceSpace setup.php page should now show.
ResourceSpace setup
- When setting up ResourceSpace ensure you enter "mariadb" as the Database IP address instead of "localhost".
- Leave the MySQL binary path field empty.