Skip to content
This repository has been archived by the owner on Nov 19, 2021. It is now read-only.

Commit

Permalink
Updated INSTALL instructions, contributing, readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
philipn committed Nov 25, 2011
1 parent 70cf327 commit ed62751
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 34 deletions.
13 changes: 8 additions & 5 deletions CONTRIBUTING
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,13 @@
4. For non-trivial contributions, agree to the contributor agreement:
http://localwiki.org/cla

Email patches to [email protected], issue a GitHub pull request, or post
them to the LocalWiki development mailing list.
Email issue a GitHub pull request, email patches to [email protected], or
post them to the LocalWiki development mailing list.

Please also see our ticketing system at:

https://github.com/localwiki/localwiki/issues

Please also see our ticketing system at http://code.trac.localwiki.org/.
Picking out some tickets to work on is a great way to get started on the
project!

Expand All @@ -22,9 +25,9 @@ great way to quickly chat about functionality and plans!
If using GitHub:

1. Fork on GitHub (click Fork button)
2. Clone to computer ($ git clone [email protected]:you/sapling.git )
2. Clone to computer ($ git clone [email protected]:you/localwiki.git )
3. Set up remote upstream
($ git remote add upstream git://github.com/localwiki/sapling.git)
($ git remote add upstream git://github.com/localwiki/localwiki.git)
4. Create a branch for new issue ($ git checkout -b 100-new-feature)
5. Develop on issue branch.
[Time passes, the main LocalWiki repository accumulates new commits]
Expand Down
63 changes: 36 additions & 27 deletions INSTALL
Original file line number Diff line number Diff line change
@@ -1,66 +1,75 @@
Here's how to get this code running on Ubuntu Server Edition 10.04 LTS. For
more general install instructions see the NOTE at the bottom of this document.
For non-development installs we *highly* recommend using our standard
installation packages. Details here:

http://localwiki.org/install

These packages are much easier to keep updated.

The following install instructions are geared for development setups or non-Ubuntu
installs.

1. Prerequisites: solr + jetty, python imaging library, python lxml bindings,
python-setuptools, virtualenv, gdal, postgresql with postgis:
python-setuptools, virtualenv, gdal, postgresql with postgis. Here's how we
get these packages in Ubuntu 10.04 LTS:

$ sudo apt-get install python-setuptools solr-jetty python-lxml python-imaging
$ sudo apt-get install gdal-bin proj postgresql-8.4-postgis python-psycopg2
$ sudo easy_install --upgrade virtualenv

2. Create a virtualenv. For more info, see http://pypi.python.org/pypi/virtualenv
2. Create a virtualenv. For more info, see http://pypi.python.org/pypi/virtualenv.
*Note*: We store some important site-specific data in the virtualenv, so don't
delete it without first backing up the share/localwiki directory inside it.

$ virtualenv env

Activate the new environment. Run all of the following commands in this environment:
$ source env/bin/activate

3. Install required python packages using requirements.txt:
(env)$ pip install --upgrade -r install_config/requirements.txt
$ source env/bin/activate

4. Create the database and database user. Here's how we do it:
3. Install the localwiki package and its dependencies:

(env)$ sudo -u postgres bash install_config/create_template_postgis-debian.sh
(env)$ sudo -u postgres createuser sapling -PSDR # REMEMBER THE PASSWORD YOU TYPE HERE!
(env)$ sudo -u postgres createdb -E UTF8 -T template_postgis -O sapling sapling
(env)$ python setup.py install

You may want to customize the db privileges based on your local setup.
4. Allow the search, diff services to start & back up existing config. This will
differ between systems. We use this setup_jetty.sh script on Ubuntu systems:

5. Allow the search, diff services to start & back up existing config:
(env)$ sudo install_config/setup_jetty.sh

6. Copy sapling/localsettings_template.py to sapling/localsettings.py:
(env)$ cp sapling/localsettings_template.py sapling/localsettings.py
Take a look at the setup_jetty.sh script (it's short). You may need to
customize it for your particular OS.

Edit sapling/localsettings.py, adding your db password from step 5.
5. Initialize the localwiki install:

Initialize the project environment:
(env)$ localwiki-manage setup_all

(env)$ python sapling/manage.py syncdb
(env)$ python sapling/manage.py migrate
(env)$ python sapling/manage.py collectstatic
(env)$ python sapling/manage.py reset_permissions
(env)$ python sapling/manage.py loaddata basic_pages
You'll be asked to sudo in order to create the postgres database.

You are now done configuring and installing things! You can start the built-in
Django development server:

(env)$ python sapling/manage.py runserver
(env)$ localwiki-manage runserver

Hooray! You can visit the site at http://127.0.0.1:8000/

Note: For security/efficiency, the built-in server listens on 127.0.0.1 only.
For real deployments you'll want to use an actual webserver. The code
isn't production ready yet, so don't do that.
For real deployments you'll want to set up apache.
See http://guide.localwiki.org for more instructions.

Note: You'll want to run source env/bin/activate every time you want to access
the localwiki-manage command.

-------------------------------------------------------------------------------
These instructions are specific to Ubuntu Server Edition 10.04 LTS. It should
be very possible to run this on any *nix system. You'll need to:
We've really only tested things on Ubuntu Server Edition 10.04 LTS. It should
be very possible to run this on any Unix-y system. You'll need to:

* Hunt down the correct prerequisites for Step 1.
* Make sure that Step 5 is completed. Take a peek at install_config/setup_jetty.sh
to see what it's doing. It's simple stuff, really, but the configuration files
may be in a different spot on your system.

Help us document this stuff! Add something to http://guide.localwiki.org or
the github wiki.

== Database Note ==
This setup assumes we're using PostgreSQL and its geographic companion,
PostGIS. You should in theory be able to use any supported Django database.
Expand Down
4 changes: 2 additions & 2 deletions README
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
We're _really_, _really_ just getting started here.
We're _really_ just getting started here.

For project information, please see http://code.trac.localwiki.org/.

We've got a development mailing list here:

http://lists.localwiki.org/mailman/listinfo/localwiki-dev
http://lists.localwiki.org/mailman/listinfo/localwiki-dev

We hang out in IRC #localwiki on the FreeNode network. Join us & help out!
=============================================
Expand Down

0 comments on commit ed62751

Please sign in to comment.