skip to navigation
skip to content

Not Logged In

adhocracy 2.1.0

Policy drafting and decision-making web platform

Latest Version: 2.3.0

Adhocracy
=========


About
-----

Adhocracy is a web based software tool which facilitates cooperative policy
drafting, proposal discussion and decisions in distributed groups.

It is primarily developed by the `Liquid Democracy e.V. <http://liqd.de>`_ as a
platform to implement Liquid Democracy concepts, as well as to provide a simple
and working general purpose online participation platform.


Technology
----------

Adhocracy is mostly written in Python 2. It's built on top of many free
software projects, such as the Pylons web framework, the Solr search platform,
Memcached, Redis, many Python libraries and more.


Installing
----------

Adhocracy is known to run on current Linux systems, such as Debian Squeeze. It
might run on FreeBSD or OS X, but this hasn't been tested recently.

Installation is usually done through buildout or through an installer script
for Debian based systems. In either case, read `INSTALLATION.rst
<INSTALLATION.rst>`_.


Development
-----------

Adhocracy is openly developed as free software and distributed for the common
good under the `AGPLv3 license <http://www.gnu.org/licenses/agpl-3.0.html>`_.

Source code hosting, bug tracking and planned feature discussion is done `on
GitHub <https://github.com/liqd/adhocracy>`_.

Communication also takes place on the `adhocracy-dev mailing list
<http://lists.liqd.net/cgi-bin/mailman/listinfo/adhocracy-dev>`_.

Documentation is included in the source code and can be read online `on
readthedocs <http://adhocracy.readthedocs.org>`_.

We're very open for contributions, please drop us a note on the mailing list or
create a pull request on GitHub.


Support
-------

Community support is available through the `adhocracy-dev mailing list
<http://lists.liqd.net/cgi-bin/mailman/listinfo/adhocracy-dev>`_.

Commercial support (installation, hosting, customization, training) is offered
by the Liquid Democracy e.V. - you can reach us at `info(at)liqd(dot)de`.

Adhocracy installation
======================

Adhocracy makes heavy use of
`buildout <https://pypi.python.org/pypi/zc.buildout>`_, a Python build
tool. It downloads, configures and builds nearly all dependencies to
create a repeatable and isolated environment. In addition it sets up the
supervisord service manager, which allows to easily start and stop the
services which Adhocracy needs to run:

-  adhocracy (http server that runs Adhocracy with Spawning/WSGI)
-  adhocracy\_worker (background queue processing)
-  solr (searching)
-  memcached (key-value cache)
-  redis (internal messaging queue)

Adhocracy is known to work on all modern Linux distributions, but should
also run on OS X and FreeBSD with minor modifications.

There are two supported ways of installing Adhocracy:

-  A fully automatic installation, which downloads and sets up
   everything, is available for Debian, Ubuntu and Arch Linux. This is
   basically a wrapper around buildout.

-  The manual installation, which directly uses the buildout commands.

Both are described in the following.

Automatic installation on debian, Ubuntu or Arch Linux with build.sh
--------------------------------------------------------------------

On debian, Ubuntu, or Arch you can simply execute the following in a
terminal:

::

    wget -nv https://raw.github.com/liqd/adhocracy/develop/build.sh -O build.sh && sh build.sh

The script will use sudo to install the required dependencies, and
install, set up, and start the required services.

Add ``-c hhu`` to install with the preconfiguration for HHU Düsseldorf.

Manual installation
-------------------

## Preparations

Install required system packages (Debian Squeeze example):

::

    $ sudo apt-get install gcc make build-essential bin86 unzip libpcre3-dev mercurial git libssl-dev libbz2-dev pkg-config
    $ sudo apt-get install python python-setuptools
    $ sudo apt-get install libsqlite3-dev postgresql-server-dev-9.1
    $ sudo apt-get install openjdk-6-jre
    $ sudo apt-get install ruby rubygems

To make the apache vhost config work run:

::

    $ sudo apt-get install libapache2-mod-proxy-html
    $ sudo a2enmod proxy proxy_http proxy_html

Check out Adhocracy:

::

    $ git clone https://github.com/liqd/adhocracy
    $ cd adhocracy

    $ git submodule init
    $ git submodule update

## Setup an isolated python environment to run Adhocracy

To install Adhocracy you need python (2.6|2.7) with PIL (python imaging) but
no other system-packages.

Compile python and PIL with the included python buildout::

    $ cd python
    $ python bootstrap.py
    $ bin/buildout
    $ cd ..

## Install and start Adhocracy

Run buildout:

::

    $ bin/python bootstrap.py
    $ bin/buildout

Start Adhocracy and dependent servers:

::

    $ bin/supervisord

If you do not use the buildout to compile and start the database system
(currently only possible for PostgreSQL, but disabled by default), you
have to setup the Adhocracy database manually:

::

    $ bin/paster setup-app etc/adhocracy.ini --name=content

Run Adhocracy
-------------

Start Adhocracy and all dependent servers:

::

    $ bin/supervisord

Restart servers:

::

    $ bin/supervisorctl reload

View the status of all servers:

::

    $ bin/supervisorctl status

To start/stop one server:

::

    $ bin/supervisorctl stop <name>

Start the Adhocracy server in foreground mode:

::

    $ bin/supervisorctl stop adhocracy
    $ bin/paster serve etc/adhocracy.ini

Buildout configuration
----------------------

-  Read ``buildout_commmon.cfg`` and ``buildout_development.cfg`` to
   learn all buildout configuration options.
-  Customize ``buildout.cfg`` to change the domains, ports and server
   versions.
-  Instead of compiling all dependencies (postgres, solr,..) you can
   also use system packages.
-  Use your custom buildout file to remove the included files you do not
   need:

   [buildout] extends = buildout\_development.cfg parts -= postgresql

Developer instructions
----------------------

To use your own `fork <https://help.github.com/articles/fork-a-repo>`_
instead of the regular("upstream") adhocracy, use
```git remote`` <http://www.kernel.org/pub/software/scm/git/docs/git-remote.html>`_:

::

    $ git remote -v
    origin  https://github.com/liqd/adhocracy (fetch)
    origin  https://github.com/liqd/adhocracy (push)
    $ git remote add USERNAME https://github.com/USERNAME/adhocracy
    $ git push USERNAME

You can now execute ``git pull origin`` to update your local copy with
new upstream changes. Use
```commit`` <http://www.kernel.org/pub/software/scm/git/docs/git-commit.html>`_
and
```push`` <http://www.kernel.org/pub/software/scm/git/docs/git-push.html>`_
to record and publish your changes. As soon as you are confident that
you have implemented a feature or corrected a bug, create a `pull
request <https://help.github.com/articles/using-pull-requests>`_ to ask
the core developers to incorporate your changes.

Adhocracy Changelog
===================


2.1.0 (2014-02-04)
------------------

This upgrade only splits the SQLAlchemy-related changes from the 2.0.0 release
in order to make sure all migrations are executed and the database remains in
a consistent state.

Changes:

- Update SQLAlchemy from 0.7.10 to 0.9.1

- Switch from sqlalchemy-migrate to Alembic. (#219)


Upgrade instructions:
~~~~~~~~~~~~~~~~~~~~~

If you haven't upgraded for a long time (say six months or more), it's best to
delete ``parts``, ``eggs``, ``python/python-2.7`` and ``python/parts``
directories and rebuild everything according to ``INSTALLATION.rst``.

In any case, don't upgrade to 2.1.0 in one go, but upgrade to 2.0.0 first by
running::

    git checkout 2.0.0
    bin/buildout
    bin/paster setup-app etc/adhocracy.ini --name=content

And upgrade to 2.1.0 in a second step::

    git checkout 2.1.0
    bin/buildout
    bin/paster setup-app etc/adhocracy.ini --name=content

This makes sure the remaining sqlalchemy-migration based migrations are
executed in the first step, and the Alembic environment is initialized properly
in the second step.


2.0.0 (2014-02-03)
------------------

- Start doing releases using semantic versioning (#77). This release's
  changelog contains many changes from the past two years, but rather
  incomplete.

- Allow to list norms in a tiled fashion. (#714)

- Add container pages. These special norms act as containers of other norms.
  (#709)

- Proposal descriptions can now be shown directly in proposal lists. (#733)

- It is now possible to translate the English source strings through Transifex
  as it is done in all other languages. In Transifex, the `en_GB` language
  is used as the "translated" English langauage in contrast to the "source"
  English langauage and doesn't imply that british English shall be used.
  (#102)

- Automatically crop and center uploaded images (logos etc) to the desired
  size. (#711)

- Badges can now be managed in context. (#713)

- Add images and long description texts to categories. Categories can now be
  listed and individually displayed, each showing all assigned proposals.
  (#695)

- Added user import script. (#649)

- We redesigned the instance settings. The most notable change is the added
  possibility to select presets on instance creation. (#680)

  The user import and massmessage services have been moved.  They can be found
  on the members index and instance overview, respectively.

- It is now possible to follow instances. (#655)

- All milestones now must have a date. (#658)

- Added installation option to freeze the complete installation. (#289)

- It is possible to select whether other users can edit a proposal.
  We added an instance option to set the default value of that option. (#632)

- a11y improvements.

- Added replay notification script, which recreates notifications inside the
  database which would have been created before notifications were stored in
  the database. (#624)

- We completely redesigned the user profile (#430) and dashboard (#429): User
  can upload an avatar now (#641) and view notifications online.

- Email texts are now wrapped at 78 characters per line. Long links are
  preserved. (#593)

- Added travis configuration which automatically builds Adhocracy using
  build.sh and runs the test suite.

- It is now possible to assign user badges in user import.
  It is also possible to define additional variables which can be used in
  the welcome email.

- Added an installation option to redirect to an instance instead of showing
  the front page. This is useful for single-instance installations. (#431)

- New comment design.

- Subnorms can now be displayed as sections. This way you can add a large
  document consisting of multiple sections and have each of these sections
  discussed separately.

- It is now possible to show all open proposals in the proposal list of future
  milestones. For milestones in the past, this doesn't have any effect. (#562)

  This will be used in the following scenario:

  - There's regular (offline) board meetings. These are entered as milestones.
    During a meeting, the board shall work on as many of the highest rated,
    non-frozen proposals as time permits.
  - All covered proposals will be assigned to the respective milestone, marked
    as frozen and badged as "implemented" (or whatever).
  - All not covered proposals will be covered in successive meetings.

- It is now possible to freeze single proposals. (#559)

- Overlays have their own urls now, so you can link to them. (#553)

- Add warning to users of unsupported browsers. (#111)

- Better user settings layout. (#174)

- Allow footer customization through static URLs. (#472)

- Add custom "show more" markdown extension. (#120)

- build.sh now has Fedora support

- Refactor all CSS and some of the templates to make development and
  theming easier. We also switched to SCSS.

- Added varnish reverse proxy [joka]

- Readd bin/test to run tests (wrapper for py.test) [joka]

- Update python from 2.7.4 to 2.7.5. Please rebuild python:

    * cd python
    * bin/buildout

  [joka]

- Use pytest testrunner instead of nose. (#343)

- Add shibboleth based authentication. (#359)

- Allow to disable tutorials installation-wide. (#54)

- Update buildout from 1.7 to 2.1.0 (#241). Rerun buildout with::

      bin/buildout -n

  If you have versions conflicts with distribute delete the old one::

      rm -r eggs/distribute..".

  [joka]

- The default way to isolate your python environment is now to compile
  python and PIL now instead of using virtualenv::

    Upgrade manual installation:
    ----------------------------

    Checkout python buildout

    * git submodule init
    * git submodule update

    Compile python:

    * cd python
    * python boostrap.py && bin/buildout

    Reinstall Adhocracy:

    * cd ../
    * rm -rf eggs/*
    * bin/python bootstrap.py
    * bin/buildout

    Upgrade build.sh:
    -----------------

    * rm -rf eggs/*
    * sh build.sh -u
    * sh build.sh -s

    [joka]

- Add controversy sorting method to proposals. (#258)

- Allow to hide voting lists from the UI. (#189)

- Badges with thumbnails. (#191)

- Option to disable registration. (#43)

- Login via email address

- Hierarchical categories. (#95)

- Formatted norms. (#192)

- Replace RabbitMQ/amqp with redis/rq (#220). This means that you have to
  provide a working redis instance if you want to use asyncronous
  jobs (highly recommended in production).
  The background process that processes the jobs is renamed from
  'background' to 'worker'. You can call it with
  `bin/paster --plugin=adhocracy worker -c etc/adhocracy.ini`

  Configuration changes:

  * dropped: adhocracy.amqp.* settings are not required anymore.
  * new: adhocracy.redis.host: An IP address redis can bind to
    (not a hostname!)
  * new: adhocracy.redis.port: The port redis will open
  * new: adhocracy.redis.queue: The queue name

- Mandatory email validation. (#142)

- Invisible badges. (#116)

- Instance-based user rating sorting. (#190)

- Disallow multiple usernames with only case differences. (#171)

- Dashboard style instance overview page. (#90)

- Support path based instances instead of subdomain only. (#62)

- Feedback instance pull in form. (#88)

- Lamson mailserver dummy for development purposes.

- Added facet search to the instance listing. The listing is based on solr now,
  please reindex. [joka]

- Instances can have badges now. To create instance badges use the
  site-administration -> badges form. To assign badges use the
  instance listing. [joka]

- New config option "adhocracy.registration.email.blacklist" that
  accepts a whitespace seperated list of email address and
  blocks registrations with those. Dots will be stripped before
  the test (to catch gmail addresses where dots are ignored by gmail).
  [csenger]

- New config option "adhocracy.listings.instance.sorting" that makes
  the sort options for the instance listing configurable. This
  possible values are: OLDEST, NEWEST, ACTIVITY and ALPHA. [csenger]

- Permission change: When we test the 'norm.create' permission
  (permission to create Norms/Topics/Themen we do no longer
  restrict it to users who also have 'instance.admin'. The main
  permission we check now is 'page.create'.

  Please check the permission 'page.create' in your permission
  settings (<base_url>/admin -> Permissions). [csenger]

- Give the users the option to permanently activate the twitter,
  facebook or google+ buttons. Save the setting in a wildcard
  subdomain cookie so it is valid across all instances.

  This requires a updated js.socialshareprivacy to work with
  our auth cookie. [csenger]

- Add the possibility to overwrite templates in <adhocracy.site>/templates
  directory (like it's possible for static resources and static pages already.
  New templates there need a server restart to be picked up.
  [csenger]

- Deliver (almost) all resources with fanstatic. [csenger]

- Delegateables can have category badges. [joka]

- Instances can have badges, they are only valid inside that instance. [joka]

- Added option to set the smtp port. [joka]

- Many bugfixes.

- Many other unmentioned improvements.


1.2a4
-----

- Tooltips use jquery tools now. [joka]
- Open helper link, login and register form with overlay. [joka]
- Recaptcha support (disabled by default). [joka]
- Proposals can have badgets #263. [joka]


1.2a1
-----

- Users can have badgets #214. [carsten]
- Proposal listing with natural sort #212. [joka]


1.1 (2010-12-05)
----------------

- Join "Goal" and "Implementation" pages on proposals.
- Migrate from whoosh to solr.
- Allow single-instance mode of operation.
- Allow per-instance deactivation of norms.
- Remove wiki from system.
- Change from cron-initiated regular background processing.
  to continuous background queue polling process.
- Add INSTALL.txt and CHANGES.txt.
- Change from BSD license to AGPL-3.
- Update to SQLAlchemy 0.6.
- Many smaller bug fixes.


1.0 (2010-07-24)
----------------

- Initial stable release.

Adhocracy is licensed under the GNU Affero General Public License, Version 3,
which can be found in LICENSE.txt

Adhocracy is Copyright 2009, 2010, 2011, 2012, 2013, 2014 by

Friedrich Lindenberg
Joscha Krutzki
Carsten Senger
Nicolas Dietrich
Philipp Hagemeister
Tobias Bengfort

and others. Check git history to get a list of all contributors.
 
File Type Py Version Uploaded on Size
adhocracy-2.1.0.zip (md5) Source 2014-02-04 23MB
  • Downloads (All Versions):
  • 120 downloads in the last day
  • 462 downloads in the last week
  • 2018 downloads in the last month