Merge branch 'release/4.0.0' into main

Author: jechols

Makefile

@@ -21,8 +21,12 @@ src/version/build.go:
 	go generate rais/src/version
 
 # Binary building rules
-binaries: src/transform/rotation.go src/version/build.go plugins
+binaries: src/transform/rotation.go src/version/build.go plugins rais-server jp2info
+
+rais-server:
 	go build -ldflags="-s -w" -o ./bin/rais-server rais/src/cmd/rais-server
+
+jp2info:
 	go build -ldflags="-s -w" -o ./bin/jp2info rais/src/cmd/jp2info
 
 # Testing
@@ -49,6 +53,11 @@ clean:
 docker: | force-getbuild generate
 	docker build --rm --target build -f $(MakefileDir)/docker/Dockerfile -t uolibraries/rais:build $(MakefileDir)
 	docker build --rm -f $(MakefileDir)/docker/Dockerfile -t uolibraries/rais:latest-indev $(MakefileDir)
+	make docker-alpine
+
+# Build just the alpine image for cases where we want to get this updated / cranked out fast
+docker-alpine: | force-getbuild generate
+	docker build --rm --target build -f $(MakefileDir)/docker/Dockerfile-alpine -t uolibraries/rais:build-alpine $(MakefileDir)
 	docker build --rm -f $(MakefileDir)/docker/Dockerfile-alpine -t uolibraries/rais:latest-alpine $(MakefileDir)
 
 # Build plugins on any change to their directory or their go files

README.md

@@ -3,15 +3,14 @@
 Rodent-Assimilated Image Server
 =======
 
-![Gocutus](gocutus.png?raw=true "Gocutus")
+![Gocutus, the RAIS mascot](gocutus.png?raw=true "Gocutus, the RAIS mascot")
 
 RAIS was originally built by [eikeon](https://github.com/eikeon) as a 100% open
 source, no-commercial-products-required, proof-of-concept tile server for JP2
 images within [chronam](https://github.com/LibraryOfCongress/chronam).
 
 It has been updated to allow more command-line options, more source file
-formats, more features, conformance to the [IIIF](http://iiif.io/) spec, and
-experimental DeepZoom support.
+formats, more features, and conformance to the [IIIF](http://iiif.io/) spec.
 
 RAIS is very efficient, completely free, and easy to set up and run.  See our
 [wiki](https://github.com/uoregon-libraries/rais-image-server/wiki) pages for
@@ -20,16 +19,49 @@ more details and documentation.
 Configuration
 -----
 
+### Main Configuration Settings
+
 RAIS uses a configuration system that allows environment variables, a config
 file, and/or command-line flags.  See [rais-example.toml](rais-example.toml)
 for an example of a configuration file.  RAIS will use a configuration
 file if one exists at `/etc/rais.toml`.
 
 The configuration file's values can be overridden by environment variables,
 while command-line flags will override both configuration files and
-environtmental variables.  Configuration is best explained and understood by
+environmental variables.  Configuration is best explained and understood by
 reading the example file above, which describes all the values in detail.
 
+### Cloud Settings
+
+Because connecting to a cloud provider is optional, often means using a
+container-based setup, and differs from one provider to the next, all RAIS
+cloud configuration is environment-only.  This means it can't be specified on
+the command line or in `rais.toml`.
+
+Currently RAIS can theoretically support S3, Azure, and Google Cloud backends,
+but only S3 has had much testing.  To set up RAIS for S3, you would have to
+export the following environment variables (in addition to having an
+S3-compatible object store running):
+
+- `AWS_ACCESS_KEY_ID`: Required
+- `AWS_SECRET_ACCESS_KEY`: Required
+- `AWS_REGION`: Required
+- `RAIS_S3_ENDPOINT`: optionally set for custom S3 backends; e.g., "minio:9000"
+- `RAIS_S3_DISABLESSL`: optionally set this to "true" for custom S3 backends
+  which don't need SSL (for instance if they're running on the same server as
+  RAIS)
+- `RAIS_S3_FORCEPATHSTYLE`: optionally set this to "true" to force path-style
+  S3 calls.  This is typically necessary for custom S3 backends like minio, but
+  not for AWS.
+
+Other backends have their own environment variables which have to be set in
+order to have RAIS connect to them.
+
+For a full demo of a working custom S3 backend powered by minio, see `docker/s3demo`.
+
+**Note** that external storage is going to be slower than serving images from
+local filesystems!  Make sure you test carefully!
+
 IIIF Features
 -----
 
@@ -41,9 +73,8 @@ for an in-depth look at feature support.
 Caching
 -----
 
-RAIS can internally cache the IIIF `info.json` requests, individual tile
-requests, and, if it's in use, S3 images to a locally configured location.  See
-the [RAIS Caching](https://github.com/uoregon-libraries/rais-image-server/wiki/Caching)
+RAIS can internally cache the IIIF `info.json` requests and individual tile
+requests.  See the [RAIS Caching](https://github.com/uoregon-libraries/rais-image-server/wiki/Caching)
 wiki page for details.
 
 Generating tiled, multi-resolution JP2s
@@ -65,3 +96,10 @@ License
 
 RAIS Image Server is in the public domain under a
 [CC0](http://creativecommons.org/publicdomain/zero/1.0/) license.
+
+Contributors
+-----
+
+Special thanks to Jessica Dussault (@jduss4) for providing the hand-drawn
+"Gocutus" logo, and Greg Tunink (@techgique) for various digital refinements to
+said logo.

docker-compose.override-example.yml

@@ -25,7 +25,7 @@ services:
       # options through from the host's environment (or the local .env file)
       - RAIS_S3CACHE
       - RAIS_S3ZONE
-      - RAIS_S3BUCKET
+      - RAIS_S3ENDPOINT
       - AWS_ACCESS_KEY_ID
       - AWS_SECRET_ACCESS_KEY
       - AWS_SESSION_TOKEN

docker-compose.yml

@@ -16,13 +16,15 @@ services:
       - RAIS_ADDRESS
       - RAIS_LOGLEVEL
       - RAIS_TILEPATH
-      - RAIS_IIIFURL
+      - RAIS_IIIFWEBPATH
+      - RAIS_IIIFBASEURL
       - RAIS_INFOCACHELEN
       - RAIS_TILECACHELEN
       - RAIS_IMAGEMAXAREA
       - RAIS_IMAGEMAXWIDTH
       - RAIS_IMAGEMAXHEIGHT
-      - RAIS_PLUGINS
+      - RAIS_PLUGINS=*
+      - RAIS_JPGQUALITY
       - RAIS_ALLOW_INSECURE_PLUGINS=0
     volumes:
       - ./docker/images:/var/local/images:ro

docker/Dockerfile

@@ -7,7 +7,7 @@
 #
 #     # Generate the build image to simplify local development
 #     docker build --rm -t uolibraries/rais:build --target build -f ./docker/Dockerfile .
-FROM fedora:30 AS build
+FROM fedora:32 AS build
 LABEL maintainer="Jeremy Echols <jechols@uoregon.edu>"
 
 # Install all the build dependencies
@@ -30,7 +30,7 @@ RUN dnf install -y GraphicsMagick
 
 # Go comes after other installs to avoid re-pulling the more expensive
 # dependencies when changing Go versions
-RUN curl -L https://dl.google.com/go/go1.13.7.linux-amd64.tar.gz > /tmp/go.tgz
+RUN curl -L https://dl.google.com/go/go1.14.4.linux-amd64.tar.gz > /tmp/go.tgz
 RUN cd /opt && tar -xzf /tmp/go.tgz
 
 # "Install" Go

docker/Dockerfile-alpine

@@ -7,25 +7,13 @@ FROM golang:1-alpine AS build
 LABEL maintainer="Jeremy Echols <jechols@uoregon.edu>"
 
 # Install all the build dependencies
-RUN apk add --no-cache openjpeg-dev
-RUN apk add --no-cache git
-RUN apk add --no-cache gcc
-RUN apk add --no-cache make
-RUN apk add --no-cache tar
-RUN apk add --no-cache curl
-
-# Installing GraphicsMagick is wholly unnecessary, but helps when using the
-# build box for things like converting images.  Since opj2_encode doesn't
-# support all formats, and ImageMagick has been iffy with some conversions for
-# us, "gm convert" is a handy fallback.  As this is a multi-stage dockerfile,
-# this installation doesn't hurt the final production docker image.
-RUN apk add --no-cache graphicsmagick
+RUN apk add --no-cache openjpeg-dev git gcc make
 
 # This is necessary for our openjp2 C bindings
 RUN apk add --no-cache musl-dev
 
-# Make sure the build box can lint code
-RUN go get -u golang.org/x/lint/golint
+# This is just getting absurd, but results in a dramatically smaller rais-server
+RUN apk add --no-cache upx
 
 # Add the go mod stuff first so we aren't re-downloading dependencies except
 # when they actually change
@@ -39,7 +27,9 @@ RUN go mod download
 ADD ./Makefile /opt/rais-src/Makefile
 ADD ./src /opt/rais-src/src
 ADD ./scripts /opt/rais-src/scripts
-RUN make
+RUN make rais-server
+
+RUN upx ./bin/rais-server
 
 # Production image just installs runtime deps and copies in the binaries
 FROM alpine:3.10 AS production

docker/demo-rais-entry.sh

@@ -1,19 +1,17 @@
-#!/usr/bin/env bash
+#!/usr/bin/env sh
 
 # demo-rais-entry.sh is the RAIS entrypoint script, which sets up the
 # configuration and runs the rais server
 
 # Copy the config and edit it in-place; this allows customizing most pieces of
 # configuration for demoing
 url=${URL:-}
-if [[ $url == "" ]]; then
+if test "$url" == ""; then
   echo "No URL provided; defaulting to 'http://localhost'"
   echo "If you can't see images, try an explicitly-set URL, e.g.:"
   echo
   echo "    URL="http://192.168.0.5" docker-compose up"
   url="http://localhost"
 fi
 
-cp /etc/rais-template.toml /tmp/rais.toml
-sed 's|^\s*IIIFURL.*$|IIIFURL = "'$url'/images/iiif"|' /tmp/rais.toml > /etc/rais.toml
 exec /opt/rais/rais-server

docker/demo-web-entry.sh

@@ -16,20 +16,8 @@ for file in $(find /var/local/images -name "*.jp2" -o -name "*.tiff" -o -name "*
     sources="$sources,"
   fi
 
-  sources="$sources\"/images/iiif/$relpath/info.json\""
+  sources="$sources\"/iiif/$relpath/info.json\""
 done
 sed "s|%SRCS%|$sources|g" /usr/share/nginx/html/template.html > /usr/share/nginx/html/iiif.html
 
-sources=""
-for file in $(find /var/local/images -name "*.jp2" -o -name "*.tiff" -o -name "*.jpg"); do
-  relpath=${file##/var/local/images/}
-  relpath=${relpath//\//%2F}
-  if [[ $sources != "" ]]; then
-    sources="$sources,"
-  fi
-
-  sources="$sources\"/images/dzi/${relpath}.dzi\""
-done
-sed "s|%SRCS%|$sources|g" /usr/share/nginx/html/template.html > /usr/share/nginx/html/dzi.html
-
 exec nginx -g "daemon off;"

docker/nginx.conf

@@ -2,27 +2,21 @@ server {
     listen       80;
     server_name  localhost;
 
-    location /images/dzi {
+    location /iiif/ {
         proxy_set_header Host $host;
         proxy_set_header X-Real-IP $remote_addr;
         proxy_set_header X-Forwarded-For $remote_addr;
-        proxy_set_header X-Forwarded-Host $remote_addr;
-        proxy_pass http://rais:12415;
-    }
-
-    location /images/iiif {
-        proxy_set_header Host $host;
-        proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header X-Forwarded-For $remote_addr;
-        proxy_set_header X-Forwarded-Host $remote_addr;
+        proxy_set_header X-Forwarded-Host $host;
+        proxy_set_header X-Forwarded-Proto $scheme;
         proxy_pass http://rais:12415;
     }
 
     location /admin {
         proxy_set_header Host $host;
         proxy_set_header X-Real-IP $remote_addr;
         proxy_set_header X-Forwarded-For $remote_addr;
-        proxy_set_header X-Forwarded-Host $remote_addr;
+        proxy_set_header X-Forwarded-Host $host;
+        proxy_set_header X-Forwarded-Proto $scheme;
         proxy_pass http://rais:12416;
     }
 

docker/s3demo/Dockerfile

@@ -1,12 +1,12 @@
-FROM golang:1.11 as build-env
+FROM golang:1 as build-env
 RUN apt-get update
+RUN apt-get install -y upx-ucl
 WORKDIR /s3demo
 ADD s3demo/go.mod /s3demo/go.mod
 ADD s3demo/go.sum /s3demo/go.sum
 RUN go mod download
 ADD ./s3demo/*.go /s3demo/
 RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags="-s -w" -o server
-RUN apt-get install -y upx-ucl
 RUN upx ./server
 
 FROM alpine