Installing Archetype (en)

To use Archetype, you must install three pieces of software: Docker, Kitematic (optional but recommended) and Archetype itself. The software packages total over 15 GB, so you must ensure you have enough hard-disk space and a good internet connection before beginning. The installation takes some time but it only needs to be done once.

For Windows users: please note that you must have virtualisation enabled to use Docker. Instructions to check if your machine has this, and how to fix it if not, are available at https://www.trishtech.com/2017/08/check-if-virtualization-is-enabled-in-windows-10/

Instructions are available online at https://hub.docker.com/r/kingsdigitallab/archetype/ > ‘How to install Docker and Kitematic’ et ‘How do I install Archetype for Docker?’. These instructions here are a summary/rephrasing of those online, along with some screen-shots to illustrate the process.

1. Download and install ‘Docker Community Edition (Stable)’ (Docker CE Stable):

• Mac: https://store.docker.com/editions/community/docker-ce-desktop-mac
• Windows: https://store.docker.com/editions/community/docker-ce-desktop-windows
• Linux Ubuntu: https://store.docker.com/editions/community/docker-ce-server-ubuntu
• Other systems: https://store.docker.com/search?offering=community&type=edition

2. Download and install ‘Kitematic’: https://github.com/docker/kitematic/releases

Now we will use Kitematic to download and install Archetype itself:

3. Launch Kitematic. It will ask you to create an account but this is optional and you can skip this if you want. NB that for Linux you must launch Kitematic in 'superuser' mode (with `sudo`).

4. Inside Kitematic, click on 'Docker CLI' (on the bottom left of the Kitematic window).

5. You should now see a terminal window (with black or blue background and a cursor where you can type). Copy the appropriate line from below and paste it into the terminal window. Note that each of these is a single instruction to be pasted in as a single line (even if it appears as several lines in your e-mail). Be sure to select the correct option for your system!

   Windows :

   docker pull kingsdigitallab/archetype:latest; docker run -d --name archetype -p 9080:80 kingsdigitallab/archetype:latest; echo ”INSTALLED”;

   Mac/Linux :

   docker pull kingsdigitallab/archetype:latest; docker run -d --name archetype -v \~/Documents/Kitematic/archetype/home/digipal/digipal\_project:/home/digipal/digipal\_project:cached -p 9080:80 kingsdigitallab/archetype:latest; echo "INSTALLED”;

   Archetype will now automatically download, install and start up by itself. This will take some time, and you must wait until you see the message 'INSTALLED' in the terminal window. Be patient!

6. You can now close the terminal (type CTRL-D or 'exit').

7. Back in Kitematic, you should now see ‘Archetype (archetype:latest)’ at the left of the window under 'Containers'. Click on this 'Archetype'. You should now see a black pane 'Container logs', with a lot of text and ‘WEBSITE IS RUNNING’ at the end. If not then keep waiting until this message appears.

   If you are using Windows and you receive an error message about Hyper V, VT-x, AMD-V or similar then you probably do not have virtualisation enabled on your machine. Instructions to check if your machine has this, and how to fix it if not, are available at https://www.trishtech.com/2017/08/check-if-virtualization-is-enabled-in-windows-10/

8. Finally, copy and paste the following URL into your browser: http://localhost:9080. You should now see your Archetype site. Alternatively you can also click on the icon in Kitematic that looks like a square with an arrow pointing out of it ('Web Preview').

Archetype is now installed and running. The next time you want to use it, you need only launch Kitematic, click on 'Start', and wait until the 'WEBSITE IS RUNNING' message appears.

Note that this website is only visible from your computer: it is not public and no-one else can access your material. If you want to make this public then you will need to find a proper web hosting service that can manage Docker images, or (better) set up a proper installation with web server, database and image server.