Blame view

src/colab-spb-plugin/README.rst 1.4 KB
a6ea3966   Gust   Change repository...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
.. -*- coding: utf-8 -*-

.. highlight:: rest

.. _colab_software:

=================================
Colab-Spb - A Gitlab-Noosfero Connector for the SPB
=================================



What is Colab?
==============

Application that integrates existing systems to represent the contributions of the members through:

* Discussions at the mailman list.

* And other systems in the community.



Features
========

* Developed by Interlegis Communities http://colab.interlegis.leg.br/

* Written in Python http://python.org/

* Built with Django Web Framework https://www.djangoproject.com/

* Search engine with Solr https://lucene.apache.org/solr/



Installation
============

After installing the colab

.. code-block::

  pip install colab-spb

Create a colab plugin configuration fila with at least the following:

.. code-block::

  vim /etc/colab/plugins.d/colab_spb.py

  name='colab_spb'

Running Colab
=============

To run Colab with development server you will have to:

1- Create the example configuration file:

.. code-block::

  colab-init-config > /etc/colab/settings.py
0a4236ff   Alexandre Barbosa   Fix flake8
64

a6ea3966   Gust   Change repository...
65
2- Edit the configuration file. Make sure you set everything you need including **database** credentials.
0a4236ff   Alexandre Barbosa   Fix flake8
66
67

3- Run the development server:
a6ea3966   Gust   Change repository...
68
69
70
71
72
73

.. code-block::

  colab-admin runserver 0.0.0.0:8000


0a4236ff   Alexandre Barbosa   Fix flake8
74
**NOTE**: In case you want to keep the configuration file else where just set the
a6ea3966   Gust   Change repository...
75
desired location in environment variable **COLAB_SETTINGS**.