Updating ISLE docs

docs/installation/docker-available-commands.md

@@ -0,0 +1,51 @@
+# Available Commands
+
+There's a lot of useful commands available to you from within the `isle-dc` folder.
+
+## Rebuild docker-compose.yml
+
+`make -B docker-compose.yml` will rebuild your `docker-compose.yml` file based on configuration in your `.env` file.  `make demo` and `make local` will automatically do this for you, but if you change configuration at a later point in time, you'll need to run this command to see your changes reflected.
+
+## Config Export
+
+`make config-export` will export your site's configuration to your site's config sync directory (usually `config/sync` inside your Drupal root folder).
+
+## Config Import
+
+`make config-import` will import site's configuration from your site's config sync directory (usually `config/sync` inside your Drupal root folder).
+
+## Database Dump
+
+`make drupal-database-dump DEST=/your/path/dump.sql` will dump your Drupal database and place the file at `DEST`.
+
+## Database Import
+
+`make drupal-database-import SRC=/your/path/dump.sql` will import your Drupal database from the file at `SRC`.
+
+## Export Public Files
+
+`make drupal-public-files-dump DEST=/your/path/public_files.tgz` will export your public filesystem and place it as a single zipped tarball at `DEST`. 
+
+## Import Public Files
+
+`make drupal-public-files-import SRC=/your/path/public_files.tgz` will import your public filesystem from a single zipped tarball at `SRC`. 
+
+## Fcrepo Export
+
+`make fcrepo-export DEST=/your/path/fcrepo-export.tgz` will export your Fedora repository and place it as a single zipped tarball at `DEST`
+
+## Fcrepo Import
+
+`make fcrepo-import SRC=/your/path/fcrepo-export.tgz` will import your Fedora repository from a single zipped tarball at `SRC`
+
+## Reindex Fedora Metadata
+
+`make reindex-fcrepo-metadata` will reindex RDF metadata from Drupal into Fedora.
+
+## Reindex Solr
+`make reindex-solr` will rebuild rebuild Solr search index for your repository. 
+
+## Reindex the Triplestore
+
+`make reindex-triplestore` will reindex RDF metadata from Drupal into Blazegraph. 
+

docs/installation/docker-available-configuration.md

@@ -0,0 +1,228 @@
+# Available Configuration
+
+ISLE Docker Compose has a single configuration file, `.env`. Within it, here
+is all the values you can set and their effects. This list is subjectively sorted
+in order of importance and usefulness.
+
+### ENVIRONMENT
+
+Setting the `ENVIRONMENT` changes how your `docker-compose.yml` file gets constructed. When you
+switch from a demo to development to production environment, this is the variable to change.
+
+Available values for this setting are
+
+- `demo` - For demo environments where you do not need access to the codebase
+- `local` - For development environments where you need edit the codebase
+- `custom` - For production environments where your codebase gets baked into a custom container
+
+By default, this is set to `demo`.
+
+If you change this setting, you need to `make -B docker-compose.yml` to generate a new `docker-compose.yml`
+file that contains the changes you've made.
+
+### DOMAIN
+
+What domain your Islandora site will be available at. If you are deploying anywhere other than 
+your personal machine, you'll probably want to change this.
+
+By default, this is set to `islandora.traefik.me`. 
+
+If you change this setting, you need to `make -B docker-compose.yml` to generate a new `docker-compose.yml`
+file that contains the changes you've made.
+
+!!! Warning "Changing this after installation has consequences"
+    If you are indexing RDF metadata in Fedora and/or a triplestore, please be aware of the implications of changing this once you have installed.  By changing your domain, all of the subjects of your triples will be incorrect and you will have to reindex.  There are `make` commands to streamline this proccess, but if you have lots of data it can potentially be costly in terms of time and effort.
+
+### REPOSITORY
+
+Repository to use for pulling isle-buildkit images.
+
+By default, this is set to `islandora`.  Change to `local` to use images you have built locally with isle-buildkit,
+or use your custom docker registry if you have set up one.
+
+If you change this setting, you need to `make -B docker-compose.yml` to generate a new `docker-compose.yml`
+file that contains the changes you've made.
+
+### TAG
+
+The version of the `isle-buildkit` images to use. Non `isle-buildkit` images have their versions specified explicitly
+in their respective docker-compose files.
+
+By default, this is set to the latest stable release of `isle-buildkit`.
+
+If you change this setting, you need to `make -B docker-compose.yml` to generate a new `docker-compose.yml`
+file that contains the changes you've made.
+
+### USE_SECRETS
+
+Whether or not you want to use secrets.  For demo and development environments, secrets are
+not required.  They are essential if you are running a production environment, though.
+
+Secrets are contained in the `secrets` folder withiin your `isle-dc` installation.  Each file represents
+an individual secret, and its contents are the value you're trying to protect.
+
+Available values for this setting are
+- `true`
+- `false`
+
+If you change this setting, you need to `make -B docker-compose.yml` to generate a new `docker-compose.yml`
+file that contains the changes you've made.
+
+### DRUPAL_INSTALL_PROFILE
+
+Which install profile to use when making an initial installation.  Valid values for this setting are the machine
+names of any Drupal profile.
+
+By default, this is set to `standard`.
+
+### INSTALL_EXISTING_CONFIG
+
+Set this to `true` if you want to install an existing Drupal site whose configuration was exported with 
+`drush config:export` 
+
+Available values for this setting are
+- `true`
+- `false`
+
+By default, this is set to `false`.
+
+If you set this to `true`, be sure to set `DRUPAL_INSTALL_PROFILE` to `minimal`.
+
+### INCLUDE_WATCHTOWER_SERVICE
+
+Whether or not to include Watchtower as a service.  When developing `isle-buildkit`, this is extremely useful and
+will auto-deploy new containers as you make changes.  You should _not_ use watchtower on prodution environments, though.
+
+Available values for this setting are
+- `true`
+- `false`
+
+By default, this is set to `true`.
+
+If you change this setting, you need to `make -B docker-compose.yml` to generate a new `docker-compose.yml`
+file that contains the changes you've made.
+
+### INCLUDE_ETCD_SERVICE
+
+Whether or not to include `etcd` as a service.
+
+Available values for this setting are
+- `true`
+- `false`
+
+By default, this is set to `false`. If you don't know what `etcd` is, then leave this be.
+
+If you change this setting, you need to `make -B docker-compose.yml` to generate a new `docker-compose.yml`
+file that contains the changes you've made.
+
+### INCLUDE_CODE_SERVER_SERVICE
+
+Whether or not to include the `coder` IDE as a service. If you're developing on Islandora, this can
+be pretty useful when developing. You should _not_ deploy this service on production environments. 
+
+Available values for this setting are
+- `true`
+- `false`
+
+By default, this is set to `false`.
+
+If you change this setting, you need to `make -B docker-compose.yml` to generate a new `docker-compose.yml`
+file that contains the changes you've made.
+
+### DRUPAL_DATABASE_SERVICE
+
+Which database engine to use for Drupal.
+
+Available values are
+- mariadb
+- postgres
+
+By default, this value is set to `mariadb`.
+
+If you change this setting, you need to `make -B docker-compose.yml` to generate a new `docker-compose.yml`
+file that contains the changes you've made.
+
+!!! Warning "Changing this after installation has consequences"
+    If you are changing from mariadb to potsrgres or vice versa, you _MUST_ migrate your data yourself.  ISLE will not convert your database from one to the other, and it's generally not advised to change this once you've installed.
+
+### FCREPO_DATABASE_SERVICE
+
+Which database engine to use for Fedora.
+
+Available values are
+- mariadb
+- postgres
+
+By default, this value is set to `mariadb`.
+
+If you change this setting, you need to `make -B docker-compose.yml` to generate a new `docker-compose.yml`
+file that contains the changes you've made.
+
+!!! Warning "Changing this after installation has consequences"
+    If you are changing from mariadb to potsrgres or vice versa, you _MUST_ migrate your data yourself.  ISLE will not convert your database from one to the other, and it's generally not advised to change this once you've installed.
+
+### COMPOSE_HTTP_TIMEOUT
+
+Sometimes when bringing up containers, you can encounter timeouts with an error like this:
+
+```
+ERROR: An HTTP request took too long to complete. Retry with --verbose to obtain debug information.
+If you encounter this issue regularly because of slow network conditions, consider setting COMPOSE_HTTP_TIMEOUT to a higher value (current value: XXX).
+```
+
+By default, this value is set to 480, but if you have slow network conditions and encounter this error, consider bumping it higher.
+
+### COMPOSE_PROJECT_NAME
+
+Used for naming services in traefik as well as defining network alias and urls. For example the `drupal` service will be found at
+`${COMPOSE_PROJECT_NAME}_drupal_1`. This is useful to change if you are running mulitple ISLE instances on one machine.
+
+By default, this value is set to `isle-dc`.
+
+If you change this setting, you need to `make -B docker-compose.yml` to generate a new `docker-compose.yml`
+file that contains the changes you've made.
+
+### COMPOSE_DOCKER_CLI_BUILD
+
+Allows building your custom image when setting `ENVIRONMENT=custom`
+
+By default, this is set to 1.
+
+You most likely will never have a need to change this.
+
+### DOCKER_BUILDKIT
+
+Instructs Docker to use buildkit when building your custom image.
+
+By default, this is set to 1.
+
+You most likely will never have a need to change this. Trust us, you want buildkit.
+
+### PROJECT_DRUPAL_DOCKERFILE
+
+The name of the Dockerfile to use after setting `ENVIRONMENT=custom`.
+
+By default, this is set to `Dockerfile`.
+
+You most likely will never have a need to change this.
+
+If you change this setting, you need to `make -B docker-compose.yml` to generate a new `docker-compose.yml`
+file that contains the changes you've made.
+
+### DISABLE_SYN
+
+Set this to `true` to disable JWT authentication for Fedora.  This is neccessary
+when performing a Fedora import using their import/export tools.
+
+By default, this is set to `false`.
+
+### FEDORA_6
+
+Whether or not to use Fedora 6.  If you set this to `false`, you will be given Fedora 5.
+In general, unless you already have an existing site on Fedora 5, you'll want Fedora 6.
+
+By default, this is set to `true`.
+
+If you change this setting, you need to `make -B docker-compose.yml` to generate a new `docker-compose.yml`
+file that contains the changes you've made.
+

docs/installation/docker-basic-usage.md

@@ -0,0 +1,97 @@
+# Basic Usage
+
+After you've finished installing Islandora using ISLE, here's some useful information to keep close at hand
+about running your site.
+
+## Important Files
+
+The `make` commands that you used to install Islandora will leave you with two very important files.
+
+| File                 | Purpose                                                                                                                                                                                                                                                                     |
+| :------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `.env`               | A configuration file that is yours to customize. This file controls how the docker-compose.yml file gets generated to meet your use case.</br>It also allows you to set variables that make their way into the final `docker-compose.yml` file, such as your site's domain. |
+| `docker-compose.yml` | A ready to run `docker-compose.yml` file based on your `.env` file.  This file is considered disposable. When you change your `.env` file, you will generate a new one.                                                                                                     |
+
+## Available Services
+
+Here's a list of all the available services.  Note that there are some services over `http` and not `https`.
+Those aren't meant to be exposed to the public, but internally people from your organization will want to
+access them.  In practice, you can restrict access to these services using firewall rules to just those who
+you trust.
+
+| Service     | Url                                                                                            |
+| :---------- | :--------------------------------------------------------------------------------------------- |
+| Drupal      | [https://islandora.traefik.me](https://islandora.traefik.me)                                   |
+| Traefik     | [http://islandora.traefik.me:8080](https://islandora.traefik.me:8080)                          |
+| Fedora      | [http://islandora.traefik.me:8081/fcrepo/rest](https://islandora.traefik.me:8081/fcrepo/rest)  |
+| Blazegraph  | [http://islandora.traefik.me:8082/bigdata](https://islandora.traefik.me:8082/bigdata)          |
+| Activemq    | [http://islandora.traefik.me:8161](https://islandora.traefik.me:8161)                          |
+| Solr        | [http://islandora.traefik.me:8983](https://islandora.traefik.me:8983)                          |
+| Cantaloupe  | [https://islandora.traefik.me/cantaloupe](https://islandora.traefik.me/cantaloupe)             |
+| Matomo      | [https://islandora.traefik.me/matomo/](https://islandora.traefik.me/matomo/)                   |
+| Code Server | [http://islandora.traefik.me:8443/](https://islandora.traefik.me:8443/)                        |
+
+## Basic Commands
+
+### Stopping Islandora
+
+If you want to stop Islandora, you can bring down all the containers with
+
+```
+docker-compose down
+``` 
+
+### Restarting Islandora
+
+If you want to start Islandora back up after stopping it, use
+
+```
+docker-compose up -d
+```
+
+### Deleting Islandora
+
+If you want to stop Islandora and delete all of its content, use
+
+```
+docker-compose down -v
+```
+
+### Regenerating docker-compose.yml
+
+If you make changes to configuration in the .env file, you may need to regnerate your `docker-compose.yml` file so that
+those changes take effect.
+
+```
+make -B docker-compose.yml
+```
+
+Once you have a new `docker-compose.yml` file, you'll need to restart your containers that have had configuration change.
+You can do this easily with
+
+```
+docker-compose up -d
+```
+
+Even if the site is up and running, that commnad will only retart the containers it needs to.
+
+### Listing services
+
+You can see a list of all the containers that you have running and their statuses by running
+
+```
+docker ps -a
+```
+
+### Tailing Logs
+
+You can tail logs using
+
+`docker-compose logs service_name`
+
+For example, to tail nginx logs for Drupal, use `docker-compose logs drupal`.
+
+If you don't know what you're looking for exactly, you can turn on the fire hose and look through all logs by dropping
+the service name and simply using
+
+`docker-compose logs`