ResourceSpace

https://www.resourcespace.com/knowledge-base
Admin
ResourceSpace is an open-source digital asset management system that helps organizations manage,...
Tokens:890,725
Snippets:8,247
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Navigate to web root on Windows

Source: https://www.resourcespace.com/knowledge-base/systemadmin/upgrading

Example path for the ResourceSpace installation directory on Windows.

```bash
C:/inetpub/wwwroot/resourcespace
```

--------------------------------

### Access Setup Page

Source: https://www.resourcespace.com/knowledge-base/systemadmin/install_docker

Navigate to the local web address to complete the ResourceSpace installation.

```text
http://localhost
```

--------------------------------

### Example of storing array values in a plugin setup page

Source: https://www.resourcespace.com/knowledge-base/developers/functions/config_gen_setup_post

Use this pattern within a setup page to add multiple definitions for keys within a single configuration option.

```php
foreach($usergroups as $k => $group)
{
global $usergroupemails;
if(!isset($usergroupemails[$group["ref"]])){$usergroupemails[$group["ref"]]=array();} // Define any missing keys
$page_def[] = config_add_text_list_input("usergroupemails[".$group["ref"]."]",$group["name"]); //need to pass a string that looks like: "$configoption["key"]"
}
```

--------------------------------

### Navigate to web root on Linux

Source: https://www.resourcespace.com/knowledge-base/systemadmin/upgrading

Example path for the ResourceSpace installation directory on Linux.

```bash
/var/www/html/resourcespace
```

--------------------------------

### Configure Dependency Paths

Source: https://www.resourcespace.com/knowledge-base/systemadmin/install_windows

Example paths for external dependencies to be entered during the web-based installation process.

```text
C:\imagemagick
C:\gs\gs9.10\bin
C:\ffmpeg\bin
C:\exiftool
```

--------------------------------

### Enable and Start Typesense Service

Source: https://www.resourcespace.com/knowledge-base/plugins/typesense_search

Enable and start the Typesense server service.

```bash
sudo systemctl enable typesense-serversudo systemctl start typesense-server
```

--------------------------------

### Build and Start Containers

Source: https://www.resourcespace.com/knowledge-base/systemadmin/install_docker

Build the Docker image and start the services in detached mode.

```bash
docker compose up --build -d
```

--------------------------------

### Install MySQL repository

Source: https://www.resourcespace.com/knowledge-base/systemadmin/install_centos

Installs the downloaded MySQL repository package.

```bash
sudo yum localinstall mysql80-community-release-el7-1.noarch.rpm
```

--------------------------------

### Upgrade PHP on Linux via APT

Source: https://www.resourcespace.com/knowledge-base/systemadmin/php_upgrades

Example commands for installing PHP 8.0 and associated modules on Debian-based Linux distributions.

```bash
sudo apt install -y php8.0
sudo apt install -y libapache2-mod-php8.0
sudo apt install -y php8.0-cli
sudo apt install -y php8.0-mysqli
......
etc.
```

--------------------------------

### Install Typesense

Source: https://www.resourcespace.com/knowledge-base/plugins/typesense_search

Install the downloaded debian package.

```bash
sudo dpkg -i typesense-server.deb
```

--------------------------------

### Install Git

Source: https://www.resourcespace.com/knowledge-base/systemadmin/install_docker

Update package lists and install the Git version control system on Ubuntu.

```bash
sudo apt update && sudo apt install git -y
```

--------------------------------

### Start Unoserver listener

Source: https://www.resourcespace.com/knowledge-base/systemadmin/openoffice

Command to start the Unoserver process in the background.

```bash
unoserver &
```

--------------------------------

### new_user API Response Examples

Source: https://www.resourcespace.com/knowledge-base/api/new_user

Examples of API responses for successful user creation, existing username conflicts, and permission errors.

```text
Array
(
    [status] => success
    [data] => {  
        "ref": 41  
    }
)
```

```text
Array
(
    "status": "fail",
    "data": {
        "ref": false
    }
)
```

```text
Array
(
    [status] => fail
    [data] => Array
        (
            [message] => Permission denied.
        )
)
```

--------------------------------

### Install dependencies via Homebrew

Source: https://www.resourcespace.com/knowledge-base/systemadmin/install_macosx

Update Homebrew and install required system packages and PHP.

```bash
brew update
```

```bash
brew install imagemagick httpd mysql subversion ghostscript exiftool wget ffmpeg poppler
```

```bash
brew install --cask inkscape
```

```bash
brew install php
```

--------------------------------

### Install project dependencies

Source: https://www.resourcespace.com/knowledge-base/developers/manage_code_dependency_frontend

Install all required dependencies from the ResourceSpace root directory using the pnpm-lock.yaml file.

```bash
pnpm install
```

--------------------------------

### Reindex Script Examples

Source: https://www.resourcespace.com/knowledge-base/plugins/typesense_search

Examples of running the reindex script with specific batch sizes and reference offsets.

```bash
php plugins/typesense_search/scripts/reindex.php 500
```

```bash
php plugins/typesense_search/scripts/reindex.php 500 100000
```

--------------------------------

### Example usage of setup_command_line_user

Source: https://www.resourcespace.com/knowledge-base/developers/functions/setup_command_line_user

Demonstrates the array structure required to define user permissions and defaults when initializing a command-line user.

```php
["username" => "My Application",  
"permissions" => "h,v,e0",  
"groupname => "My Application",  
"resource_defaults => "region=EMEA",  
]
```

--------------------------------

### Define plugin_activate_for_setup()

Source: https://www.resourcespace.com/knowledge-base/developers/functions/plugin_activate_for_setup

This function registers language files, includes hooks from the plugin's all.php file, and loads configuration settings.

```php
function plugin_activate_for_setup($plugin_name)
{
    // Add language file
    register_plugin_language($plugin_name);

    // Include <plugin>/hooks/all.php case functions are included here
    $pluginpath = get_plugin_path($plugin_name);
    $hookpath = $pluginpath . "/hooks/all.php";

    if (file_exists($hookpath)) {
        include_once $hookpath;
    }

    // Include plugin configuration for displaying on Options page
    $active_plugin = ps_query("SELECT `name`, enabled_groups, config, config_json FROM plugins WHERE `name` = ? AND inst_version >= 0 order by priority", array("s", $plugin_name));

    if (empty($active_plugin)) {
        include_plugin_config($plugin_name);
    } else {
        include_plugin_config($plugin_name, $active_plugin[0]['config'], $active_plugin[0]['config_json']);
    }

    return true;
}
```

--------------------------------

### Get maximum theme levels definition

Source: https://www.resourcespace.com/knowledge-base/developers/functions/get_max_theme_levels

This function queries the database to identify the highest numeric suffix among columns starting with 'theme'.

```php
function get_max_theme_levels(){
    $sql = "show columns from collection like 'theme%'";
    $results = sql_query($sql);
    foreach($results as $result) {
        if ($result['Field'] == 'theme'){
            $level = 1;
        } else {
            $thislevel = substr($result['Field'],5);
            if (is_numeric($thislevel) && $thislevel > $level){
                $level = $thislevel;
            }
        }
    }
    return $level;
}
```

--------------------------------

### Set initial file permissions

Source: https://www.resourcespace.com/knowledge-base/systemadmin/install_macosx

Create the filestore directory and set initial write permissions.

```bash
mkdir filestore
```

```bash
sudo chmod 777 filestore
```

```bash
sudo chmod -R 777 include
```

--------------------------------

### Search Get Previews JSON Response

Source: https://www.resourcespace.com/knowledge-base/api/search_get_previews

Example of the JSON array returned by the search_get_previews endpoint containing resource metadata and preview URLs.

```json
[
{"score":"0",
"ref":"38",
"resource_type":"1",
"has_image":"0",
"is_transcoding":"0",
"hit_count":"0",
"creation_date":"2016-08-09 14:00:05",
"rating":"",
"user_rating":"",
"user_rating_count":"",
"user_rating_total":"",
"file_extension":"jpg",
"preview_extension":"jpg",
"image_red":"",
"image_green":"",
"image_blue":"",
"thumb_width":"",
"thumb_height":"",
"archive":"0",
"access":"0",
"colour_key":"",
"created_by":"1",
"file_modified":"2016-08-09 14:00:05",
"file_checksum":"",
"request_count":"0",
"new_hit_count":"0",
"expiry_notification_sent":"0",
"preview_tweaks":"0|1",
"file_path":"",
"group_access":"",
"user_access":"",
"field12":"2016-08-09 12:59",
"field8":"Example Photo",
"field3":"Lebanon",
"url_thm":"https:\/\/imagelibrary.resourcepace.com\/filestore\/1\/1\/3\/2\/2\/9_916fb06cda226ee\/113229thm_7fe1c8566474a07.jpg?v=2017-03-01+14%3A02%3A17",
"url_pre":"https:\/\/imagelibrary.resourcepace.com\/filestore\/1\/1\/3\/2\/2\/9_916fb06cda226ee\/113229pre_e2d041035b30bf5.jpg?v=2017-03-01+14%3A02%3A17",
"url_col":"https:\/\/imagelibrary.resourcepace.com\/filestore\/1\/1\/3\/2\/2\/9_916fb06cda226ee\/113229col_3272c919ca5e1a0.jpg?v=2017-03-01+14%3A02%3A17"
}
]
```

--------------------------------

### Install poppler

Source: https://www.resourcespace.com/knowledge-base/systemadmin/install_centos

Installs poppler as a replacement for xpdf.

```bash
yum install poppler
```

--------------------------------

### Start FastAPI Service

Source: https://www.resourcespace.com/knowledge-base/plugins/faces

Launch the face recognition service with database credentials and port configuration.

```bash
python faces_service.py --db-host=localhost --db-user=resourcespace --db-pass=yourpassword --port=8001
```

--------------------------------

### Install ImageMagick

Source: https://www.resourcespace.com/knowledge-base/systemadmin/install_centos

Installs ImageMagick and its required prerequisites.

```bash
yum install php-pear gcc php-devel php-pear
yum install ImageMagick
```

--------------------------------

### Install Unoconv

Source: https://www.resourcespace.com/knowledge-base/systemadmin/openoffice

Command to install the Unoconv utility on Debian-based systems.

```bash
sudo apt-get install unoconv
```

--------------------------------

### Create Unoserver init script

Source: https://www.resourcespace.com/knowledge-base/systemadmin/openoffice

Shell script content for starting Unoserver on system boot.

```bash
#! /bin/sh
unoserver &
```

--------------------------------

### Example of single StaticSync alternative file structure

Source: https://www.resourcespace.com/knowledge-base/systemadmin/staticsync

Demonstrates folder structure using a single defined string suffix.

```text
/staticsync_folder/myfile.jpg
/staticsync_folder/myfile_alt_.jpg
/staticsync_folder/myotherfile.jpg
/staticsync_folder/myotherfile_alt_.jpg
```

--------------------------------

### setup_user($userdata)

Source: https://www.resourcespace.com/knowledge-base/developers/functions/setup_user

Initializes global variables for a user based on provided user data.

```APIDOC
## setup_user($userdata)

### Description
Given an array of user data loaded from the user table, set up all necessary global variables for this user including permissions, current collection, config overrides and so on.

### Parameters
- **$userdata** (array) - Required - Array of user data obtained by validate_user() from user/usergroup tables

### Return
- **boolean** - success/failure flag - used for example to prevent certain users from making API calls
```

--------------------------------

### Reindex Output Example

Source: https://www.resourcespace.com/knowledge-base/plugins/typesense_search

Example output generated by the reindexing script.

```text
Starting Typesense reindex | Batch size: 500 | Starting after ref: 0[2026-05-12 15:10:42]Indexed this batch: 500| Failed this batch: 0| Total indexed: 500| Last ref: 500| Batch content: 1,284,221 chars| Total content: 1,284,221 chars| Batch time: 4.21s| Rate: 118.77 resources/sec| Memory: 64MB
```

--------------------------------

### Install OpenAI Whisper

Source: https://www.resourcespace.com/knowledge-base/plugins/whisper

Install the OpenAI Whisper package using pip.

```bash
pip3 install -U openai-whisper
```

--------------------------------

### setup_command_line_user()

Source: https://www.resourcespace.com/knowledge-base/developers/functions/setup_command_line_user

Configures a dummy user for command-line script execution with specified permissions and group settings.

```APIDOC
## setup_command_line_user($setoptions)

### Description
Set up a dummy user with required permissions to pass permission checks when running scripts from the command line.

### Parameters
- **$setoptions** (array) - Required - An array containing user configuration such as "username", "permissions", "groupname", and "resource_defaults".
- **$options[]** (array) - Optional - Array of optional user options. Defaults to generic system admin permissions if not provided.

### Return
- **bool** - Returns true on success or false on failure.
```

--------------------------------

### Configure image alternatives via $image_alternatives

Source: https://www.resourcespace.com/knowledge-base/systemadmin/image-alternatives

Examples of defining sequential image alternative configurations for different file formats and processing requirements.

```php
# Example - automatically create a PNG file alternative when an EPS file is uploaded.
# $image_alternatives[0]["name"]="PNG File";
# $image_alternatives[0]["source_extensions"]="eps";
# $image_alternatives[0]["source_params"]="";
# $image_alternatives[0]["filename"]="alternative_png";
# $image_alternatives[0]["target_extension"]="png";
# $image_alternatives[0]["params"]="-density 300"; # 300 dpi
# $image_alternatives[0]["icc"]=false;
```

```php
# Example - automatically create a CMYK JPEG file alternative from a JPEG or TIFF
# $image_alternatives[1]["name"]="CMYK JPEG";
# $image_alternatives[1]["source_extensions"]="jpg,jpeg,tif,tiff";
# $image_alternatives[1]["source_params"]="";
# $image_alternatives[1]["filename"]="cmyk";
# $image_alternatives[1]["target_extension"]="jpg";
# $image_alternatives[1]["params"]="-quality 100 -flatten $icc_preview_options -profile ".dirname(__FILE__) . "/../iccprofiles/name_of_cmyk_profile.icc"; # Quality 100 JPEG with specific CMYK ICC Profile
# $image_alternatives[1]["icc"]=true; # use source ICC profile in command
```

```php
# Example - automatically create a JPG2000 file alternative when an TIF file is uploaded
# $image_alternatives[2]['name'] = 'JPG2000 File';
# $image_alternatives[2]['source_extensions'] = 'tif,tiff';
# $image_alternatives[2]["source_params"]="";
# $image_alternatives[2]['filename'] = 'New JP2 Alternative';
# $image_alternatives[2]['target_extension'] = 'jp2';
# $image_alternatives[2]['params'] = '';
# $image_alternatives[2]['icc'] = false;
```

--------------------------------

### Verify Tesseract Installation

Source: https://www.resourcespace.com/knowledge-base/plugins/tesseract

Check that the Tesseract binary is correctly installed and accessible.

```bash
tesseract --help
```

--------------------------------

### Install Python Dependencies

Source: https://www.resourcespace.com/knowledge-base/plugins/faces

Install the necessary Python packages for the FastAPI service.

```bash
pip install --upgrade pip
pip install fastapi uvicorn insightface onnxruntime faiss-cpu opencv-python-headless python-multipart mysql-connector-python
```

--------------------------------

### Core Preview Configuration Options

Source: https://www.resourcespace.com/knowledge-base/systemadmin/minimal-previews

Lists the configuration options that trigger the minimal preview creation behavior.

```php
• $offline_job_queue
• $enable_thumbnail_creation_on_upload
• $preview_generate_max_file_size
```

--------------------------------

### Start Unoconv listener

Source: https://www.resourcespace.com/knowledge-base/systemadmin/openoffice

Command to start the Unoconv listener process in the background.

```bash
unoconv --listener &
```

--------------------------------

### Create Unoconv init script

Source: https://www.resourcespace.com/knowledge-base/systemadmin/openoffice

Shell script content for starting the Unoconv listener on system boot.

```bash
#! /bin/sh
unoconv --listener &
```

--------------------------------

### get_featured_collections Response Example

Source: https://www.resourcespace.com/knowledge-base/api/get_featured_collections

Example of the array structure returned by the get_featured_collections function.

```text
Array
(
    [0] => Array
        (
            [ref] => 5
            [name] => Animals
            [type] => 3
            [parent] => 
            [thumbnail_selection_method] => 1
            [bg_img_resource_ref] => 
            [order_by ] => 10
            [created] => 2023-11-28 11:39:28
            [has_resources] => 0
            [has_children] => 1
        )

    [1] => Array
        (
            [ref] => 7
            [name] => Museum
            [type] => 3
            [parent] => 
            [thumbnail_selection_method] => 1
            [bg_img_resource_ref] => 
            [order_by ] => 20
            [created] => 2023-11-28 11:39:49
            [has_resources] => 1
            [has_children] => 0
        )
)
```

--------------------------------

### Convert installation to Subversion working copy

Source: https://www.resourcespace.com/knowledge-base/systemadmin/upgrading

Initializes the current directory as a Subversion working copy for the specified release.

```bash
svn co --force https://svn.resourcespace.com/svn/rs/releases/11.0 .
```

--------------------------------

### Install PHP cURL

Source: https://www.resourcespace.com/knowledge-base/plugins/typesense_search

Install the PHP cURL extension and restart Apache if missing.

```bash
sudo apt install php-curlsudo systemctl restart apache2
```

--------------------------------

### Checkout ResourceSpace via SVN

Source: https://www.resourcespace.com/knowledge-base/systemadmin/install_macosx

Commands to navigate to the web directory, create the installation folder, and perform the SVN checkout.

```bash
cd /usr/local/var/www
```

```bash
mkdir resourcespace
```

```bash
cd resourcespace
```

```bash
svn co https://svn.resourcespace.com/svn/rs/releases/11.0 .
```
Tokens:
Raw