-
Notifications
You must be signed in to change notification settings - Fork 15
Installing Archetype on a Web Server
Docker is now the recommended way to install the DigiPal framework on your machine, and documentation for this is available on the DigiPal Docker page and Running DigiPal with Kitematic. However, if you are an advanced user and wish to set up DigiPal as a production site then the following, obsolete notes written for legacy version 1.0 may contain some helpful information. For more up to date information please consult the content of the /build folder in github and see how the Docker instance works, as well as some tips on the page for Installing and Running Archetype.
Using GIT:You need to have git installed. On a Ubuntu/Debian system, you can do that by running the following command in your terminal:
sudo apt-get install git
For all the other versions, you can find them at the address http://git-scm.com/downloads.
The recommended way to download Digipal is to run this the following commands in your terminal:
git clone https://github.com/kcl-ddh/digipal
Unless you are a software developer who wants to contribute to DigiPal code base you'll need to switch to the latest stable version:
git checkout v1.0
Where v1.0 is the version you want to install. For newer versions please regularly consult the DigiPal releases page.
Alternatively, you can download the project ZIP folder at https://github.com/kcl-ddh/digipal/archive/master.zip.
A basic requirement to install DigiPal is having Python 2.6+ installed (we don't support Python 3).
Using PIP: Before installing the requirements, please make sure you have the following packages already installed:
- python-dev
- postgresql-9.3
- postgresql-server-dev-9.3
- libmysqlclient-dev
- ImageMagick
After that, run in the terminal the following command:
pip install -r requirements.txt
To see or manually install all the requirements, consult the requirements.txt file provided in the doc folder.
In order to run the DigiPal Database we used a PostgreSQL database server. Therefore, we recommend you to use PostgreSQL as well since we cannot ensure that the database will work on other database management systems.
First you'll need to create an empty database, a database user and grant that user permissions on that database. You can do that with the PgAdmin user interface or from the command line. Either way you'll need sufficient privilege on the database system to carry out those operations. If you've installed PosgreSQL yourself then you can use the 'posgres' user and the its password to access the database shell:
psql -U postgres
create database YOUR_DATABASE_NAME;
create user A_USER_NAME with password 'A_PASSWORD';
grant all privileges on database YOUR_DATABASE_NAME to A_USER_NAME;
\q
Set up the database in your local_settings.py file and fill the DATABASES object with your settings:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.postgresql_psycopg2',
'NAME': 'YOUR_DATABASE_NAME',
'USER': 'A_USER_NAME',
'PASSWORD': 'A_PASSWORD',
'HOST': 'localhost',
'PORT': '',
}
}
After that, run in your terminal the following commands:
python manage.py syncdb
python manage.py migrate
python manage.py collectstatic --noinput
By using the system terminal, go to your DigiPal root folder, and then run:
python manage.py runserver
Run you browser at the address http://localhost:8000
This is enough to get you started, but you should then then set this up with a proper production-level web server according to your local setup.
Giancarlo Buomprisco
Archetype is maintained by the King's Digital Lab at King's College London. It has received funding from the European Union Seventh Framework Programme (FP7) under Grant Agreement no. 263751 (DigiPal), the Arts and Humanities Research Council (AHRC) under Grant Reference n° AH/L008041/1 (Models of Authority) and AH/L013975/1 (Exon Domesday), and the Faculty of Arts and Humanities at King's College London.
Credits
Getting Started
Using Archetype
The Data Model
Editorial interface
- The Admin Interface
- Adding Items (Manuscripts)
- Adding Images
- Adding Hands and Scribes
- Adding Symbols (Letters)
- Content Permissions
- The Annotation Process
- Linking image regions with text regions
- Rebuilding the Indices
Customising the framework
Archetype for developers
- Installing Archetype on a Web Server
- Bulk Image Upload
- The Javascript API Library
- The Web API Syntax
- Upgrading Archetype
- Contributing to the code (third party development)
- Restoring an Archetype backup
Troubleshooting