netvor / pagure

Forked from pagure 5 years ago


Author:Pierre-Yves Chibon <>

Pagure is a git-centered forge, python based using pygit2.

With pagure you can host your project with its documentation, let your users report issues or request enhancements using the ticketing system and build your community of contributors by allowing them to fork your projects and contribute to it via the now-popular pull-request mechanism.


See it at work:

Playground version:

If you have any questions or just would like to discuss about pagure, feel free to drop by on IRC in the channel #pagure of the freenode server

Get it running

There are several options when it comes to a development environment. Vagrant will provide you with a virtual machine which you can develop on, or you can install it directly on your host machine.


For a more thorough introduction to Vagrant, see

An example Vagrantfile is provided as Vagrantfile.example. To use it, just copy it and install Vagrant:

$ cp dev/Vagrantfile.example Vagrantfile
$ sudo dnf install ansible libvirt vagrant-libvirt vagrant-sshfs vagrant-hostmanager
$ vagrant up

If you get this error Block in synced_folders: Internal error. Invalid: sshfs, when you run vagrant up , you need to install vagrant sshfs plugin, which can be done by:

$ vagrant plugin install vagrant--sshfs

and then:

$ vagrant up

The default Vagrantfile forwards ports from the host to the guest, so you can interact with the application as if it were running on your host machine.


vagrant-hostmanager will automatically maintain /etc/hosts for you so you can access the development environment from the host using its hostname, which by default is You can choose not to use this functionality by simply not installing the vagrant-hostmanager plugin, but if you want Pagure to provide valid URLs in the UI for git repositories, you will need to adjust Pagure's configuration found in ~/pagure.cfg on the guest.

Docker Compose

Create the folder that will receive the projects, forks, docs, requests and tickets' git repo:

mkdir -p lcl/{repos,remotes,attachments,releases}

A docker compose environment is available to run pagure. First use the following command to build the containers.

$ docker-compose -f dev/docker-compose.yml build

Once all the containers are built, run the following command to start the containers.

$ docker-compose -f dev/docker-compose.yml up -d

Once all the containers have started, you can access pagure on http://localhost:5000

To stop the containers, run the following

$ docker-compose -f dev/docker-compose.yml stop

More information about docker-compose cli see

Running the unit-tests

To run the unit-tests, there is container available with all the dependencies needed.

Use the following command to run the tests

$ ./dev/

This command will build a fedora based container and execute the test suite.

If you wish to execute the test suite on a centos based container run the following command

$ ./dev/ --centos

When the test container image has been built you can skip the building step to save time and run directly the test suite.

$ ./dev/ --skip-build
$ ./dev/ --centos --skip-build

You can also run a single test case

$ ./dev/ tests/

Or a single test

$ ./dev/ tests/

You can also get run-tests-docker help

$ ./dev/ --help


  • Install the needed system libraries:

    sudo dnf install git python2-virtualenv libgit2-devel redis \
                     libjpeg-devel gcc libffi-devel redhat-rpm-config


    Do note the version of libgit2 that you install, for example in libgit2-0.23.4-1 you need to keep in mind the 0.23


    On Fedora 23 and earlier or on RHEL and derivative (CentOS, Scientific Linux) the package python2-virtualenv is named python-virtualenv

  • Retrieve the sources:

    git clone
    cd pagure
  • Install dependencies

    • create the virtualenv:

      virtualenv pagure_env
      source ./pagure_env/bin/activate
    • Install the correct version of pygit2:

      pip install pygit2==<version of libgit2 found>.*

      So in our example:

      pip install pygit2==0.23.*
    • Install the rest of the dependencies:

      pip install -r requirements.txt
  • Create the folder that will receive the projects, forks, docs, requests and tickets' git repo:

    mkdir -p lcl/{repos,remotes,attachments,releases}
  • Copy and edit the alembic.ini file (especially the script_location key):

    cp files/alembic.ini .
    vim alembic.ini
  • Set the script_location to alembic, ie: the folder where the revisions are stored, relative to the location of the alembic.ini file.

  • Create the inital database scheme:

    python --initial alembic.ini
  • Enable and start redis server:

    systemctl enable redis
    systemctl start redis
  • Start a worker, in one terminal:

  • Run the application, in another terminal:

  • To get some profiling information you can also run it as:

    ./ --profile

This will launch the application at

  • To run unit-tests on pagure

    • Install the dependencies:

      pip install -r tests_requirements.txt
    • Run it:



      While testing for worker tasks, pagure uses celery in /usr/bin/ Celery then looks for eventlet (which we use for testing only) at system level and not in virtualenv. You will need to install eventlet outside of your virtualenv if you are using one.