summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README112
1 files changed, 44 insertions, 68 deletions
diff --git a/README b/README
index de19db5e..32f9b2bb 100644
--- a/README
+++ b/README
@@ -1,4 +1,15 @@
# Parabolaweb README
+It is recommended that you just install the (parabola) package
+`parabolaweb-utils`, it
+
+ - depends on the dependencies of parabolaweb
+ - offers initscripts and systemd service files for parabolaweb
+ - has a `parabolaweb-update` script that does most of the things here.
+
+Following is Archweb's readme, as I figure it might be useful for some people,
+but I have given up on maintaining it for parabolaweb.
+
+# Archweb README
To get a pretty version of this document, run
@@ -15,97 +26,62 @@ See AUTHORS file.
# Dependencies
- python2
-- python2-virtualenv (if using pip to manage dependencies)
+- python2-virtualenv
# Python dependencies
-We're going to use pip to handle python dependencies, m'kay?
-Worry about that in step 3.
-
-If you really want to manage dependencies using something other than
-pip, look at `requirements.txt`, and at the comments on other
-dependiencies in step 3.
-
-# Testing Installation
-
-Throughout this, we assume that parabolaweb is installed in a
-directory called `parabolaweb`. This is not necessarily true. On the
-main server, it's in `/srv/http/web'. Wherever you see this in a
-command, know that you should just replace it with the correct path
-for your install.
-
-1. Run `virtualenv2`.
-
- $ cd /path/to/parabolaweb && virtualenv2 `pwd`-env
-
- Here I just had you use `pwd` to choose the environment
- directory. You can use anything, but it is recommended that it not
- be the same directory as the install.
+More detail in `requirements.txt` and `requirements_prod.txt`; it is best to
+use virtualenv and pip to handle these. But if you insist on (Arch Linux)
+packages, you will probably want the following:
-2. Activate the virtualenv.
+- mysql-python or python-pysqlite
+- django
+- python-markdown
+- python-south
+- python-memcached
- $ source `pwd`-env/bin/activate
-
-3. Fix symlink to the environment
-
- (parabolaweb-env) $ ln -sf ../../parabolaweb-env/lib/python2.7/site-packages/django/contrib/admin/media media/admin_media
-
- Of course change `../../parabolaweb-env` to the relative path to
- your environment. Keep in mind that the path is relative from
- inside the `media/` directory, not the current directory.
-
-4. Install dependencies through `pip`.
-
- To install base dependencies, run
-
- (parabolweb-env) $ pip install -r requirements.txt
-
- After that you will need to install a database engine for python
- This means `MySQL-python==1.2.3`, `pysqlite` or `psycopg2` for
- PostgreSQL. Eg:
+# Testing Installation
- (parabolweb-env) $ pip install MySQL-python==1.2.3
+1. Run `virtualenv2`.
- You may also want to install memcached
+ $ cd /path/to/archweb && virtualenv2 ../archweb-env
- (parabolweb-env) $ pip install python-memcached==1.47
+2. Activate the virtualenv.
- Alternately, to have psycopg2 and memcached installed automatically,
- run
+ $ source ../archweb-env/bin/activate
- (parabolweb-env) $ pip install -r requirements_prod.txt
+2. Install dependencies through `pip`.
- We use PostgreSQL on the main server, and you may have problems
- with other SQLs.
+ (archweb-env) $ pip install -r requirements.txt
-5. Copy `local_settings.py.example` to `local_settings.py` and modify.
- Make sure to uncomment the appropriate db section.
+3. Copy `local_settings.py.example` to `local_settings.py` and modify.
+ Make sure to uncomment the appropriate db section (either sqlite or mysql).
-6. Sync the database to create it.
+4. Sync the database to create it.
- (parabolaweb-env) $ ./manage.py syncdb
+ (archweb-env) $ ./manage.py syncdb
-7. Migrate changes.
+5. Migrate changes.
- (parabolaweb-env) $ ./manage.py migrate
+ (archweb-env) $ ./manage.py migrate
-8. Load the fixtures to prepopulate some data. If you don't want some
- of the provided data, adjust the file glob accordingly.
+6. Load the fixtures to prepopulate some data. If you don't want some of the
+ provided data, adjust the file glob accordingly.
- (parabolaweb-env) $ ./manage.py loaddata */fixtures/*.json
+ (archweb-env) $ ./manage.py loaddata */fixtures/*.json
-9. Use the following commands to start a service instance
+7. Use the following commands to start a service instance
- (parabolaweb-env) $ ./manage.py runserver
+ (archweb-env) $ ./manage.py runserver
-10. To optionally populate the database with real data:
+8. To optionally populate the database with real data:
- $ wget https://repo.parabolagnulinux.org/core/os/i686/core.db.tar.gz
- $ ./manage.py reporead i686 core.db.tar.gz
- $ ./manage.py syncisos
+ (archweb-env) $ wget ftp://ftp.archlinux.org/core/os/i686/core.db.tar.gz
+ (archweb-env) $ ./manage.py reporead i686 core.db.tar.gz
+ (archweb-env) $ ./manage.py syncisos
- Alter architecture and repo to get x86\_64 and packages from
- other repos if needed.
+Alter architecture and repo to get x86\_64 and packages from other repos if
+needed.
# Production Installation