From 6218d3ee46ecab901de4ce5730d049cd807aaa0e Mon Sep 17 00:00:00 2001 From: Tom Wiesing Date: Sun, 28 Jun 2020 12:29:31 +0200 Subject: [PATCH] Update README and LICENSE --- README.md | 221 ++++++++++++++++++++++++---------------- LICENSE => agpl-3.0.txt | 141 ++++++++++++------------- 2 files changed, 196 insertions(+), 166 deletions(-) rename LICENSE => agpl-3.0.txt (86%) diff --git a/README.md b/README.md index 6f4358f..c5f3dbd 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,16 @@ # WissKI-Distillery -This repository contains a factory server implementation that creates and maintains a list of Drupal Instances. +WissKI-Distillery is a Docker-based server for multiple [WissKI](https://wiss-ki.eu/) Instances. -** This documentation is not yet updated to the new approach ** - -** This is a work in progress and nothing in this repository is ready for production use ** +** This project is still a work in progress and nothing in this repository is ready for production use ** ## Overview This project consists of the following: - this README -- several bash scripts in the 'factory' folder that are described below +- bash scripts for setting up and managing the distillery server +- bash scripts for backing up the server - a `Vagrantfile` for local testing The bash scripts are dependency-free and only assume that a basic debian system is available. @@ -19,52 +18,89 @@ The scripts have been tested only under Debian 10, but may also work under older All scripts expect to be run as root, and will fail when this is not the case. Each script is well-commented and all commands are explained. -Configuration of the bash scripts can be done in the file 'factory/.env'. -A sample configuration file (with documented defaults) is available in 'factory/.env.sample'. +Configuration of the bash scripts can be done in the file `distillery/.env`. +A sample configuration file (with documented defaults) is available in `distillery/.env.sample`. To get started, it is sufficient to run: ```bash -cd factory/ +cd distillery/ cp .env.sample .env your-favorite-editor .env # open and customize, usually only the domain needs adjusting ``` +## Vagrantfile + For local testing, it is recommended to use [Vagrant](https://www.vagrantup.com/) and the provided `Vagrantfile`. +After installing vagrant, run: + +```bash +# start the vargant box +vagrant up + +# open a shell inside the vm +# for debugging purposes forward port 7200 (GraphDB) and 8080 (phpmyadmin) +vagrant ssh -- -L 12 +``` + ## Preparing the Server -- 'system_install.sh' -*TLDR: `sudo bash /factory/system_install.sh /path/to/graphdb.zip`* +*TLDR: `sudo bash /dustillery/system_install.sh /path/to/graphdb.zip`* + +To prepare the server for becoming a WissKI factory, several core Docker Instances must be installed. +These are: + +- [nginx-proxy](https://github.com/nginx-proxy/nginx-proxy) -an automated nginx reverse proxy + - This will delegate individual hostnames to appropriate docker containers, see [this blog post](http://jasonwilder.com/blog/2014/03/25/automated-nginx-reverse-proxy-for-docker/) for an overview. + - Optionally makes use of [docker-letsencrypt-nginx-proxy-companion](https://github.com/nginx-proxy/docker-letsencrypt-nginx-proxy-companion) to automatically provision and renew HTTPS certificates. + - See [distillery/resources/compose/web](distillery/resources/compose/web) for implementation details. + +- [MariaDB](https://mariadb.org/) - a SQL server + - It is configured to run inside a docker container + - A passwordless `root` account is created, which can only be used from inside the container. + - A `bookkeeping` database and table is created by default, to store known WissKI instance metadata in. + - A database shell can be opened using `sudo /distillery/mysql.sh`. + - A [phpmyadmin](https://www.phpmyadmin.net/) is started on `127.0.0.1:8080`. + - See [distillery/resources/compose/sql](distillery/resources/compose/sql) for implementation details. -To prepare the server for becoming a WissKI factory, a few components need to be installed. -In particular, these are: -- [PHP](https://www.php.net/) and [Composer](https://getcomposer.org/) -- for getting and running the Drupal Code -- serveral PHP modules that are dependencies of Drupal -- [MariaDB](https://mariadb.org/) -- an SQL database -- [Apache2](https://httpd.apache.org/), the corresponding php and [mpm-itk](http://mpm-itk.sesse.net/) modules -- a webserver - [GraphDB](http://graphdb.ontotext.com/) - an SPARQL backend for WissKI + - It is configured to run inside a docker container. + - The Workbench API is started on `127.0.0.1:7200`. + - Security is not enabled at the moment. + - See [distillery/resources/compose/triplestore](distillery/resources/compose/triplestore) for implementation details. -With the exception of GraphDB all these components can be installed using Debian's package manager 'apt'. -To install GraphDB, a zip with the binaries needs to be unpacked, and then a systemd service for it needs to be created. +To manage multiple docker containers, this script makes heavy use of [docker-compose](https://docs.docker.com/compose/). -These steps can be performed automatically. -In particular, after obtaining a license and the installation zip file for 'GraphDB', one can run the 'factory/system_install.sh' script as follows to setup all components: +Setting up these steps is fully automatic. +In particular, after obtaining a license and the installation zip file for 'GraphDB', one can run the 'distillery/system_install.sh' script as follows to setup all components: ```bash -sudo bash /factory/system_install.sh /path/to/graphdb.zip +sudo bash /distillery/system_install.sh /path/to/graphdb.zip ``` In principle this script is idempotent, meaning it can be run multiple times achieving the same effect. +## Updating the Docker Containers -- 'system_update.sh' + +For security purposes, the core containers should be regularly updated. +To achieve this, the docker container images should be rebuilt and restarted. + +This can be done using: + +```bash +sudo bash /distillery/system_update.sh +``` + ## Provisioning a new WissKI instance -- 'provision.sh' -*TLDR: `sudo bash provision.sh slug-of-new-website`* +*TLDR: `sudo /distillery/provision.sh slug-of-new-website`* A new WissKI instance consists of several components: -- A [Drupal](https://www.drupal.org/) instance, managed as a [Composer](https://getcomposer.org/) project -- An [Apache](https://httpd.apache.org/) the makes the above available externally -- An [SQL](https://mariadb.org/) database, to store Drupal Nodes in -- A [GraphDB](https://graphdb.ontotext.com/) repository to store RDF triples in +- A Drupal instance inside a lightweight php runtime container +- An entry in the SQL bookkeeping table that stores instance meta-data +- An SQL database and user for Drupal +- A GraphDB repository and user as SPARQL endpoint Each WissKI instance is identified by a ``slug''. This is a preferably short name that is used to form a domain name for the WissKI instance. @@ -72,51 +108,43 @@ This factory assumes that each instance is a subdomain of a given domain. For example, if the given domain is 'wisskis.example.com' and the slug of a particular instance is 'blue', the subdomain used by this instance would be 'blue.wisskis.example.com'. The given domain can be configured within the '.env' file. -In this implementation we furthermore isolate each WissKI instance from the rest of the system. -For this purpose, we make use of an appropriate system user, an appropriate SQL user and a GraphDB user. -**Note: GraphDB users are not yet implemented ** +We use the following process to provision a new instance: -We thus use the following process to provision a new instance: +__1. Create a new docker-compose.yml file__ -__1. We create a new system user and hoem directory__ - -The username is derived from the slug, with a configurable prefix. -The home directory for this user will contain the Drupal PHP files needed to run a WissKI. -For this reason, the home directory for each user is a subdirectory at a standardized location. -By default this is `/var/www/factory/$USER', but this can be customized. +In this step we first create a directory on the real system to hold all files relating to this instance. +By default, this takes place inside `/var/www/deploy/instances/$DOMAIN`, but this can be configured. +We then create a docker-compose file in this directory that is ready for running the runtime container. __2. Create an appropriate SQL database and user__ We create a new SQL database to eventually store Drupal-related data in. -The user and database names are again generated from the slug. +The user and database names are generated from the slug. The database password is randomly generated and only made available directly to the Drupal instance later. -__3. Initialize a new composer project__ - -Within the home directory of the dedicated user, we create a new composer project that requires [drupal/recommended-project](https://github.com/drupal/recommended-project)` as well as drush. - -__4. Run the Drupal Installation scripts__ - -We run the Drupal installation scripts. -Here we tell Drupal about the database credentials, and initialize an initial 'admin' user for the drupal instance. -The password for the 'admin' user is randomly generated in this process. - -__5. Create a GraphDB repository and user__ +__3. Create a GraphDB repository and user__ Next, we create a dedidcated GraphDB repository for the WissKI instance. We also create a new GraphDB user with access to this repository. -__6. Add WissKI modules to Drupal__ +__4. Provision the instance inside the container__ -Next, we add the required WissKI modules to Drupal. -Also patch EasyRDF and make an ontology directory. -*TODO*: Configure the WissKI modules automatically. +We start the container in provisioning mode. -__7. Create a Apache VHost configuration__ +This does the following: -Finally, we create an apache vhost configuration that makes the drupal website available. -*TODO*: SSL +- Creates a new composer project that requires [drupal/recommended-project](https://github.com/drupal/recommended-project)`. +- Installs `drush` into this project. +- Runs the `drush site-install` command to configure the Drupal instance. Generates a random password to use. +- Adds and enables WissKI-specific modules for this instance. +Currently the WissKI Salz instance is not enabled programatically. +Instead all credentials (along with instructions on how to configure it) are printed to the command line. + + +__6. Start the Docker Container__ + +Finally, we can start the docker container. These steps can be performed automatically. To do so, use: @@ -125,53 +153,68 @@ To do so, use: sudo bash /factory/provision.sh SLUG ``` -## Manually editing WissKI instances -- 'shell.sh' - -Sometimes it is needed to make manual adjustments to an individual instance. -For this purpose, the `shell.sh` script exists. -It opens an interactive shell in the context of a given WissKI instance. -In particular it: -- switches to the appropriate system user -- sets up the '$PATH' environment variable to allow using 'drush' and 'composer' - -To use it, run: - -```bash -sudo bash /factory/shell.sh SLUG -``` - ## Purge an existing WissKI instance -- 'purge.sh' -* TODO: Document this more * - Sometimes it is required to remove a given WissKI instance. In particular all parts belonging to it should be removed. - To use it, run: ```bash sudo bash /factory/purge.sh SLUG ``` - -## TODO - -- Compare with Mark Fichtners approach -- More documentation - - Document and improve`update.sh` - - User-level documentation - - What is a factory? - - Why a factory? - - First steps after provisioning -- Writeup approach to SSL (Wildcard cert with proxy that downgrades connections to plain http, or mod_md) -- Automatically setup SALZ adapter (if this is possible) -- Investigate support for GraphDB Auth in WissKI Salz - - Eventually enable security if needed -- Allow customization of GraphDB installation paths - +To ensure ## License -Licensed under GPL 3. +This project and associated files in this repository are licensed as follows: + + WissKI-Distillery - A docker-based WissKI instance server + Copyright (C) 2020 The KWARC Group + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Please see `agpl-3.0.txt` for a legally binding license text. +The short summary of the license is: + +- You may use this software for any purpose, including commerical. +- You may create derivative works, and use those for any purpose, including commerical. + +if you follow the following conditions: + +- You provide the end-user with a copy of this license. +- You make the source code of any derivative works available. +- Any derivative works clearly list changes made. +- You license any derivative works under the same license. + +This also applies if you only run a backend service based on this software. + + +## TODO + +- User-level documentation + - What is a factory? + - Why a factory? + - First steps after provisioning +- Automatically setup SALZ adapter (if this is possible) +- Enable authentication for GraphDB +- Investigate support for GraphDB Auth in WissKI Salz + - Eventually enable security if needed + - Switch to a different TripleStore alltogether? +- Investigate managing phpmyadmin +- Investigate managing graphdb +- Investigate delegating shell access +- Investigate delegating ftp access diff --git a/LICENSE b/agpl-3.0.txt similarity index 86% rename from LICENSE rename to agpl-3.0.txt index f288702..be3f7b2 100644 --- a/LICENSE +++ b/agpl-3.0.txt @@ -1,5 +1,5 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies @@ -7,17 +7,15 @@ Preamble - The GNU General Public License is a free, copyleft license for -software and other kinds of works. + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to +our General Public Licenses are intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. +software for all its users. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you @@ -26,44 +24,34 @@ them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. The precise terms and conditions for copying, distribution and modification follow. @@ -72,7 +60,7 @@ modification follow. 0. Definitions. - "This License" refers to version 3 of the GNU General Public License. + "This License" refers to version 3 of the GNU Affero General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. @@ -549,35 +537,45 @@ to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. - 13. Use with the GNU Affero General Public License. + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single +under version 3 of the GNU General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General +Program specifies that a certain numbered version of the GNU Affero General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published +GNU Affero General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's +versions of the GNU Affero General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. @@ -635,40 +633,29 @@ the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by + it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. + GNU Affero General Public License for more details. - You should have received a copy of the GNU General Public License + You should have received a copy of the GNU Affero General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see +For more information on this, and how to apply and follow the GNU AGPL, see . - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -.