kallithea Changeset - 6de8a139ab07

Changeset - 6de8a139ab07

Parent rev.

Child rev.

[Not reviewed]

kallithea-2.2.5-rebrand

0 1 0

Sean Farley - 12 years ago 2014-06-28 01:50:21
sean.michael.farley@gmail.com

readme: instructions for working with RhodeCode database

1 file changed with 44 insertions and 0 deletions:

README.rst

0 comments (0 inline, 0 general)

README.rst

➞

Show inline comments

@@ @@ -104,59 +104,103 @@ Incoming / Plans @@
 - Web based merges for pull requests
 - Tracking history for each lines in files
 - Simple issue tracker
 - SSH based authentication with server side key management
 - Commit based built in wiki system
 - More statistics and graph (global annotation + some more statistics)
 - Other advancements as development continues (or you can of course make
   additions and or requests)
 License
 -------
 ``Kallithea`` is released under the GPLv3 license.
 Getting help
 ------------
 Listed bellow are various support resources that should help.
 .. note::
    Please try to read the documentation before posting any issues, especially
    the **troubleshooting section**
 - Open an issue at `issue tracker <https://bitbucket.org/conservancy/kallithea/issues>`_
 - Join #kallithea on FreeNode (irc.freenode.net)
   or use http://webchat.freenode.net/?channels=kallithea for web access to irc.
 You can follow this project on Twitter, **@KallitheaSCM**.
 Online documentation
 --------------------
 Online documentation for the current version of Kallithea is available at
  - http://packages.python.org/Kallithea/
  - http://kallithea.readthedocs.org/
 You may also build the documentation for yourself - go into ``docs/`` and run::
    make html
 (You need to have sphinx_ installed to build the documentation. If you don't
 have sphinx_ installed you can install it via the command:
 ``easy_install sphinx``)
 Converting from RhodeCode
 -------------------------
 Currently, you have two options for working with an existing RhodeCode database:
  - keep the database unconverted (intended for testing and evaluation)
  - convert the database in a one-time step
 Maintaining Interoperability
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Interoperability with RhodeCode 2.2.5 installations is provided so you don't
 have to immediately commit to switching to Kallithea. This option will most
 likely go away once the two projects have diverged significantly.
 To run Kallithea on a Rhodecode database, run::
    echo "BRAND = 'rhodecode'" > kallithea/brand.py
 This location will depend on where you installed Kallithea. If you installed via::
    python setup.py install
 then you will find this location at
 ``$VIRTUAL_ENV/lib/python2.7/site-packages/Kallithea-2.2.5-py2.7.egg/kallithea``
 One-time Conversion
 ~~~~~~~~~~~~~~~~~~~
 Alternatively, if you would like to convert the database for good, you can use
 a helper script provided by Kallithea. This script will operate directly on the
 database, using the database string you can find in your ``production.ini`` (or
 ``development.ini``) file. For example, if using SQLite::
    cd /path/to/kallithea
    cp /path/to/rhodecode/rhodecode.db kallithea.db
    pip install sqlalchemy-migrate
    python kallithea/bin/rebranddb.py sqlite:///kallithea.db
 .. WARNING::
    If you used the other method for interoperability, overwrite brand.py with
    an empty file (or watch out for stray brand.pyc after removing brand.py).
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
 .. _python: http://www.python.org/
 .. _sphinx: http://sphinx.pocoo.org/
 .. _mercurial: http://mercurial.selenic.com/
 .. _bitbucket: http://bitbucket.org/
 .. _github: http://github.com/
 .. _subversion: http://subversion.tigris.org/
 .. _git: http://git-scm.com/
 .. _celery: http://celeryproject.org/
 .. _Sphinx: http://sphinx.pocoo.org/
 .. _vcs: http://pypi.python.org/pypi/vcs

0 comments (0 inline, 0 general)