Archive Manager Plugin Documentation

About

Archive Manager Plugin is a Webnative plugin, and it lives on a Webnative server, it interacts with OnFile archiving software and can only work with archive to disk archives. It allows users to delete archives and move archives to the new location

Plugins_tab, img #01.1

Features

Delete archived files
Move archived files

Delete archived files

This action removes entries from OnFile Database, updates Webnative Database records and removes archive file physically from OnFile archive to disk location

Note: if "Force Delete" is enabled, processing will stop if error is encountered

Move archived files

This action updates entries in OnFile Database and Webnative Database, then it moves archive file physically from one OnFile archive to disk location to another (creating folder structure if needed)

Note: if "Force Move" is enabled, processing will stop if error is encountered

Archive to disk OnFile location you can change in Webnative: Volumes/Users>>Plugins>>OnFile

Than click "Locations"

Plugins_tab, img #01.1 Choose Location or Add new Location And then you can edit you Location path

Installation

Unzip plugin to the following location on a Webnative server:
```
/usr/etc/webnative/plugins
```
after copy you will get:
```
/usr/etc/webnative/plugins/ArchiveManagerPlugin.dir
```

Set permissions:

chmod -R 755  /usr/etc/webnative/plugins/ArchiveManagerPlugin.dir/ArchiveManagerPlugin.php
chmod -R 755 /usr/etc/webnative/plugins/ArchiveManagerPlugin.dir/assets
chmod -R 755 /usr/etc/webnative/plugins/ArchiveManagerPlugin.dir/protected/runtime
chown -R apache:apache /usr/etc/webnative/plugins/ArchiveManagerPlugin.dir/assets
chown -R apache:apache /usr/etc/webnative/plugins/ArchiveManagerPlugin.dir/protected/runtime

Add Archive Manager plugin to Webnative basket config file located here:

 /usr/adm/webnative/basket.config

add line (tab separated!):

ArchiveManagerPlugin.dir/ArchiveManagerPlugin.php ArchiveManager wn_basket.gif root 2

Setup Archive Manager plugin config located here:

/usr/etc/webnative/plugins/ArchiveManagerPlugin.dir/config.json

{
  "webnative": {
    "host": "<MYSQL_HOST>", (usually localhost or 127.0.0.1)
    "port": "<MYSQL_PORT>", (usually 3306)
    "sockFile": "<MYSQL_SOCK_FILE>" (usually /var/lib/mysql/mysql.sock or /tmp/mysql.sock),
    "username": "<MYSQL_USERNAME>",
    "password": "<MYSQL_PASSWORD>"
  },
  "sqlite": {
    "db": "<ONFILE_ARCHIVE_DB_NAME>" (usually /usr/inpress/onfile/data/archive.db)
  },
  "onFile": {
    "<ONFILE_LOCATION_NAME>": { (must match "Location name" field in OnFile Location setup)
      "basePath": "<ONFILE_LOCATION_PATH>" (OnFile "Base path for archive" for Disc Archive or "Base path for archive buffer" for S3/Glacier)
    },
    (Specify all available onFile locations to ensure proper deletion / move of the assets)
  }
}

and you’re all set!

Note: Deleting or moving an asset will result in deletion or movement of corresponding entries in ALL OnFile locations

Note: The plugin DOES NOT modify files in AWS storage

Usage

Remove

To remove archived asset put it into basket (for example in E6) and click “Remove” button

Move

To move archived asset put it into basket (for example in E6), set new location path and click “Move” button

Plugins Archive Manager