Commit d1010a65 authored by Alexandre Leray's avatar Alexandre Leray
Browse files

Merge branch 'master' of git.constantvzw.org:aa.wiki

parents 0fac8efc cf530dc5
FIXME: The instruction in this file are outdated since the refactoring of
aacore.
Active Archives Wiki Installation
=================================
Active Archives Core
--------------------
This is the INSTALL file for Active Archives (AA). This document provides
convenient steps so a user/developer can have AA running quickly.
Aa.wiki depends on aa.core.
Please follow the instructions in the documentation of aa.core for installing
it. The installation of aa.wiki then follows a very similar path.
Dependencies
============
Directory layout
----------------
Please first install these software in order to get AA running properly:
The default run files of aa.wiki expect the aacore package to be found within
a folder called aa.core, which is a sibling to the folder aa.wiki:
- Django += 1.3 <http://www.djangoproject.org/>
- SQLite3 <http://www.sqlite.org/>
- PySQLite2 <http://trac.edgewall.org/wiki/PySqlite>
- Git <http://git-scm.com/>
- Git-Python <http://gitorious.org/git-python>
- Google-diff-match-patch <http://code.google.com/p/google-diff-match-patch/>
- Python html5lib <http://code.google.com/p/html5lib/>
- Python markdown += 2.1 <http://www.freewisdom.org/projects/python-markdown/>
- Python dateutil <http://labix.org/python-dateutil>
- Pygraphviz <http://networkx.lanl.gov/pygraphviz/>
- Python librdf (Redland) <http://librdf.org/>
- Python mdx cite <http://pypi.python.org/pypi/mdx_cite>
- Python mdx del ins <http://pypi.python.org/pypi/mdx_del_ins>
- Python mdx semantic wikilinks <http://pypi.python.org/pypi/mdx_semanticwikilinks>
- Python mdx semantic data <http://pypi.python.org/pypi/mdx_semanticdata>
- Python mdx outline <http://pypi.python.org/pypi/mdx_outline>
apps
├── aa.core
│   ├── aacore
├── aa.wiki
│   ├── aawiki
To get started quickly it is recommended to follow this directory layout.
On Ubuntu, this should do the trick:
sudo apt-get install python-pip
sudo pip install django
sudo pip install gitpython
sudo pip install html5lib
sudo pip install markdown
sudo pip install diff-match-patch
sudo pip install python-dateutil
sudo pip install pygraphviz
sudo pip install mdx_cite
sudo pip install mdx_del_ins
sudo pip install mdx_semanticwikilinks
sudo pip install mdx_semanticdata
sudo pip install mdx_outline
sudo apt-get install python-librdf
Additionally, you'll need the following for the RDF sniffers:
- Exiftool
- Ffmpeg
- Imagemagick
Quick Installation
==================
Installation
------------
1. Clone the repository onto your machine
git clone git@git.constantvzw.org:aa.core.git
git clone git://git.constantvzw.org/aa.wiki.git
1. Once you've installed the required dependencies:
2. Install the required dependencies into a virtual environment:
cd /path/to/aa.core/run
cd aa.wiki
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt
2. Build the database:
3. Set up the app. Build the database:
python manage syncdb
cd run
python manage syncdb
The prompt will ask for the admin infos and fixtures will be loaded.
The prompt will ask for the admin infos and fixtures will be loaded.
3. Run the django webserver:
4. Run the django webserver:
python manage.py runserver
python manage.py runserver
4. Configure the project domain name at:
5. Configure the project domain name at:
<http://localhost:8000/admin/sites/site/1/>
<http://localhost:8000/admin/sites/site/1/>
Typically the value must be "localhost:8000" if you are running the project
on a local server.
vim: ft=markdown:
Installation on web servers
---------------------------
AA wiki has been tested on Apache with ModWSGI. You can follow the steps above
and then proceed to create a virtual host and a wsgi settings file for the
project. An example wsgi configuration file can be found in
run/aa.venv.example.wsgi
If you get file permission errors, the files need to readable or writable by
the Apache user (www-data).
\ No newline at end of file
Django==1.3.1
GitPython==0.3.2.RC1
Markdown==2.1.0
mdx-cite==1.0
mdx-del-ins==1.0
mdx-outline==1.02
mdx-semanticdata==1.0
mdx-semanticwikilinks==1.0
PyYAML==3.09
async==0.6.1
diff-match-patch==20110725.1
distribute==0.6.14
feedparser==5.1
gitdb==0.5.4
html5tidy==1.0
html5lib==0.90
ipython==0.11
lxml==2.2.8
......@@ -16,3 +22,4 @@ smmap==0.8.1
virtualenv==1.6.4
wsgiref==0.1.2
django-typogrify==1.2.2
django-registration==0.8
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment