use markdown in readme

This commit is contained in:
j 2016-04-15 14:21:24 +02:00
parent b3df5b8d56
commit 27830d7c58
1 changed files with 54 additions and 35 deletions

View File

@ -1,21 +1,23 @@
pan.do/ra - open media archive
# pan.do/ra - open media archive
for more information on pan.do/ra visit our website at https://pan.do/ra
for more information on pan.do/ra visit our website at https://pan.do/ra
== SETUP ==
pan.do/ra is known to work with Ubuntu 14.04,
but other distributions should also work.
The instructions below are for Ubuntu 14.04.
All commans given expect that you are root.
## SETUP
pan.do/ra is known to work with Ubuntu 14.04,
but other distributions should also work.
The instructions below are for Ubuntu 14.04.
All commans given expect that you are root.
To run pan.do/ra you need to install and setup:
To run pan.do/ra you need to install and setup:
python
postgres
nginx (or apache2)
additinal video packages
=== Installing required packages ===
## Installing required packages
1) add pandora ppa to get all packages in the required version
@ -24,6 +26,7 @@ To run pan.do/ra you need to install and setup:
apt-get update
2) install all required packages
apt-get install git subversion mercurial \
python-setuptools python-pip python-virtualenv ipython \
python-dev python-imaging python-numpy python-psycopg2 \
@ -32,29 +35,34 @@ To run pan.do/ra you need to install and setup:
poppler-utils mkvtoolnix gpac imagemagick \
python-ox oxframe ffmpeg
=== Prepare Environment ===
## Prepare Environment
1) add pandora user and set permissions
adduser pandora --disabled-login --disabled-password
adduser pandora --disabled-login --disabled-password
2) Setup Database
su postgres
createuser pandora
createdb -T template0 --locale=C --encoding=UTF8 -O pandora pandora
echo "CREATE EXTENSION pg_trgm;" | psql pandora
exit
su postgres
createuser pandora
createdb -T template0 --locale=C --encoding=UTF8 -O pandora pandora
echo "CREATE EXTENSION pg_trgm;" | psql pandora
exit
3) Setup RabbitMQ
You have to use the same password here and in BROKER_URL in local_settings.py
You have to use the same password here and in BROKER_URL in local_settings.py
rabbitmqctl add_user pandora PASSWORD
rabbitmqctl add_vhost /pandora
rabbitmqctl set_permissions -p /pandora pandora ".*" ".*" ".*"
=== Install Pan.do/ra ===
## Install Pan.do/ra
1) Get code from git
cd /srv/
git clone https://git.0x2620.org/pandora.git pandora
cd pandora
@ -66,6 +74,7 @@ You have to use the same password here and in BROKER_URL in local_settings.py
2) create local_settings.py and config.jsonc
2.1) create file /srv/pandora/pandora/local_settings.py with the following content:
DATABASES = {
'default': {
'NAME': 'pandora',
@ -84,13 +93,15 @@ You have to use the same password here and in BROKER_URL in local_settings.py
XACCELREDIRECT = True
2.2) create config.jsonc
config.jsonc holds the configuration for your site.
To start you can copy /srv/pandora/pandora/config.pandora.jsonc
to /srv/pandora/pandora/config.jsonc but have a look at
https://wiki.0x2620.org/wiki/pandora/configuration and
config.0xdb.jsonc config.padma.jsonc for configuration options.
config.jsonc holds the configuration for your site.
To start you can copy /srv/pandora/pandora/config.pandora.jsonc
to /srv/pandora/pandora/config.jsonc but have a look at
https://wiki.0x2620.org/wiki/pandora/configuration and
config.0xdb.jsonc config.padma.jsonc for configuration options.
3) initialize database
su pandora
cd /srv/pandora/pandora
./manage.py init_db
@ -102,6 +113,7 @@ You have to use the same password here and in BROKER_URL in local_settings.py
5) Setup Webserver
a) nginx (recommended)
apt-get install nginx
cp /srv/pandora/etc/nginx/pandora /etc/nginx/sites-available/pandora
cd /etc/nginx/sites-enabled
@ -114,6 +126,7 @@ a) nginx (recommended)
service nginx reload
b) apache2 (if you need it for other sites on the same server)
apt-get install apache2-mpm-prefork libapache2-mod-xsendfile
a2enmod xsendfile
a2enmod proxy_http
@ -127,26 +140,32 @@ b) apache2 (if you need it for other sites on the same server)
service apache2 reload
Now you can open pandora in your browser, the first user to sign up will become admin.
Now you can open pandora in your browser, the first user to sign up will become admin.
== Updating ==
To update pandora to the latest version run this:
su pandora
cd /srv/pandora
./update.py
## Updating
this will update pandora/oxjs/python-ox and list possible upgrades to the db
To update pandora to the latest version run this:
to update your database run:
su pandora
cd /srv/pandora
./update.py db
su pandora
cd /srv/pandora
./update.py
this will update pandora/oxjs/python-ox and list possible upgrades to the db
to update your database run:
su pandora
cd /srv/pandora
./update.py db
## Development
== Development ==
in one terminal:
./manage.py runserver 2620
and background task in another:
./manage.py celeryd -B -Q celery,default,encoding -l INFO
now you can access your local pandora instace at http://127.0.0.1:8000/