Skip to content

Commit

Permalink
Update IIIF install notes
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderWatzinger committed Oct 29, 2023
1 parent 704fe8f commit 8cd87b5
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 43 deletions.
10 changes: 5 additions & 5 deletions install.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,20 +140,20 @@ high-quality, attributed digital objects online at scale. Be aware that:
You can test http://your.server/iipsrv/iipsrv.fcgi to see if it runs.

sudo mkdir /var/www/iipsrv
sudo cp -rp /usr/lib/iipimage-server/iipsrv.fcgi /var/www/iipsrv/
sudo cp -p /usr/lib/iipimage-server/iipsrv.fcgi /var/www/iipsrv/
sudo chown -R www-data /var/www/iipsrv
sudo chmod 755 -R /var/www/iipsrv

### Configuration

Edit the configuration to your needs, see example at
[install/iipsrv.conf](install/iipsrv.conf), enable the module and restart
Apache:
[install/iipsrv.conf](install/iipsrv.conf) and restart Apache:

sudo vim /etc/apache2/mods-available/iipsrv.conf
sudo a2enmod iipsrv
sudo service apache2 restart

Further configuration can be done at the IIIF tab in the admin area of the web
application.

## Tests
Install required packages:

Expand Down
2 changes: 1 addition & 1 deletion install/iipsrv.conf
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ ScriptAlias /iiif "/var/www/iipsrv/iipsrv.fcgi"
</Location>

# Set our environment variables for the IIP server
FcgidInitialEnv VERBOSITY "6"
FcgidInitialEnv VERBOSITY "1"
FcgidInitialEnv LOGFILE "/var/log/iipsrv.log"
FcgidInitialEnv MAX_IMAGE_CACHE_SIZE "10"
FcgidInitialEnv JPEG_QUALITY "90"
Expand Down
73 changes: 36 additions & 37 deletions install/upgrade/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,15 @@ compare your **instance/production.py** with **config/default.py** in case you
made adaptions to these. The same goes for **instance/tests.py** in case you
are also using tests.

#### IIIF
For the IIIF implementation new NPM packages are needed:
#### NPM - additional packages

$ cd openatlas/static
$ rm package.json
$ pip3 install -e ./
$ ~/.local/bin/calmjs npm --install openatlas
cd openatlas/static
rm package.json
pip3 install -e ./
~/.local/bin/calmjs npm --install openatlas

If you want to use IIIF, please read the
[instructions](https://redmine.openatlas.eu/projects/uni/wiki/IIIF).
#### IIIF
If you want to use IIIF, please refer to the relevant section at **install.md**

### 7.15.0 to 7.16.0
7.16.0.sql is needed but will be taken care of by the database upgrade script.
Expand All @@ -45,10 +44,10 @@ If you want to use IIIF, please read the
7.15.0.sql is needed but will be taken care of by the database upgrade script.
For type charts new NPM packages are needed:

$ cd openatlas/static
$ rm package.json
$ pip3 install -e ./
$ ~/.local/bin/calmjs npm --install openatlas
cd openatlas/static
rm package.json
pip3 install -e ./
~/.local/bin/calmjs npm --install openatlas

### 7.13.x to 7.14.0
7.14.0.sql is needed but will be taken care of by the database upgrade script.
Expand All @@ -64,7 +63,7 @@ A code base update (e.g. with git pull) and a webserver restart is sufficient.

Install exiftran to support rotation correction of images (#1943)

# apt install exiftran
sudo apt install exiftran

#### Purging database system logs before 2022
Database system logs before 2022 will be deleted. They aren't that relevant
Expand All @@ -77,7 +76,7 @@ upgrade script.

Install python3-requests for new feature API: fetch data from ARCHE (#1848):

# apt install python3-requests
sudo apt install python3-requests

#### For developers
In case you are using tests you should take a look at
Expand All @@ -95,18 +94,18 @@ In this version the following folders, including all sub folders and files,

have to be moved manually to the **files** directory, e.g. as root

# mv openatlas/uploads/* files/uploads/
# mv openatlas/export/sql/* files/export/
# mv openatlas/processed_images/ files/processed_images/
# chown -R www-data files
sudo mv openatlas/uploads/* files/uploads/
sudo mv openatlas/export/sql/* files/export/
sudo mv openatlas/processed_images/ files/processed_images/
sudo chown -R www-data files

Clean up:

# rm openatlas/uploads/.gitignore
# rmdir openatlas/uploads
# rm openatlas/export/sql/.gitignore
# rmdir openatlas/export/sql
# rmdir openatlas/export
sudo rm openatlas/uploads/.gitignore
sudo rmdir openatlas/uploads
sudo rm openatlas/export/sql/.gitignore
sudo rmdir openatlas/export/sql
sudo rmdir openatlas/export

Be aware, that external applications/scripts, e.g. backup scripts or
presentation sites might need adaptions too.
Expand All @@ -124,16 +123,16 @@ Like announced, the deprecated API version 0.2 was removed in this release.

NPM packages need to be upgraded:

$ cd openatlas/static
$ rm package.json
$ pip3 install -e ./
$ ~/.local/bin/calmjs npm --install openatlas
cd openatlas/static
rm package.json
pip3 install -e ./
~/.local/bin/calmjs npm --install openatlas

The new CSV export function now provides files to download directly. So
the CSV folder isn't needed anymore and can be deleted (or moved elsewhere in
case you like to keep it). To remove it execute:

$ rm -R openatlas/export/csv
rm -R openatlas/export/csv

This is the last version that will support the deprecated API version 0.2.
In case other systems are still depend on it, they should be updated to use
Expand All @@ -153,10 +152,10 @@ The new stable API version is now 0.3 (instead 0.2). Systems using the API

NPM packages need to be upgraded for the Bootstrap upgrade:

$ cd openatlas/static
$ rm package.json
$ pip3 install -e ./
$ ~/.local/bin/calmjs npm --install openatlas
cd openatlas/static
rm package.json
pip3 install -e ./
~/.local/bin/calmjs npm --install openatlas

### 7.2.0 to 7.3.0
7.3.0.sql is needed but will be taken care of by the database upgrade script.
Expand All @@ -176,10 +175,10 @@ version **0.3** will be the new default. Version 0.2. will still be available

For the new map system NPM packages have to be upgraded:

$ cd openatlas/static
$ rm package.json
$ pip3 install -e ./
$ ~/.local/bin/calmjs npm --install openatlas
cd openatlas/static
rm package.json
pip3 install -e ./
~/.local/bin/calmjs npm --install openatlas

### 7.1.0 to 7.1.1
A code base update (e.g. with git pull) and a webserver restart is sufficient.
Expand All @@ -204,7 +203,7 @@ sites might be needed.
At admin/mail the port should be the default mail submission port **587**
(in most cases). If you got port **25** there, you might want to change it. You
can check the functionality with the **Send test mail** function there
afterwards.
afterward.

### 6.6.x to 7.0.0
WARNING - this is a major release and requires software upgrades. If you are
Expand Down

0 comments on commit 8cd87b5

Please sign in to comment.