Mercurial > kallithea
changeset 3363:1a498b11f154 rhodecode-0.0.1.5.3
Docs updates
| author | Marcin Kuzminski <marcin@python-works.com> |
|---|---|
| date | Tue, 12 Feb 2013 22:42:26 +0100 |
| parents | 89e7b189da64 |
| children | 9c5bfcf6cad7 |
| files | README.rst docs/changelog.rst docs/installation_win.rst docs/setup.rst docs/upgrade.rst docs/usage/general.rst docs/usage/troubleshooting.rst |
| diffstat | 7 files changed, 381 insertions(+), 281 deletions(-) [+] |
line wrap: on
line diff
--- a/README.rst Tue Feb 12 22:05:35 2013 +0100 +++ b/README.rst Tue Feb 12 22:42:26 2013 +0100 @@ -5,18 +5,18 @@ About ----- -``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_ -with a built in push/pull server and full text search and code-review. -It works on http/https and has a built in permission/authentication system with +``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_ +with a built in push/pull server, full text search and code-review. +It works on http/https and has a built in permission/authentication system with the ability to authenticate via LDAP or ActiveDirectory. RhodeCode also provides simple API so it's easy integrable with existing external systems. -RhodeCode is similar in some respects to github_ or bitbucket_, +RhodeCode is similar in some respects to github_ or bitbucket_, however RhodeCode can be run as standalone hosted application on your own server. -It is open source and donation ware and focuses more on providing a customized, -self administered interface for Mercurial_ and GIT_ repositories. -RhodeCode works on \*nix systems and Windows it is powered by a vcs_ library -that Lukasz Balcerzak and Marcin Kuzminski created to handle multiple +It is open source and donation ware and focuses more on providing a customized, +self administered interface for Mercurial_ and GIT_ repositories. +RhodeCode works on \*nix systems and Windows it is powered by a vcs_ library +that Lukasz Balcerzak and Marcin Kuzminski created to handle multiple different version control systems. RhodeCode uses `PEP386 versioning <http://www.python.org/dev/peps/pep-0386/>`_ @@ -29,7 +29,7 @@ Or:: - pip install rhodecode + pip install rhodecode Detailed instructions and links may be found on the Installation page. @@ -51,7 +51,7 @@ ----------- The latest sources can be obtained from official RhodeCode instance -https://secure.rhodecode.org +https://secure.rhodecode.org MIRRORS: @@ -68,7 +68,7 @@ RhodeCode Features ------------------ -- Has its own middleware to handle mercurial_ and git_ protocol requests. +- Has its own middleware to handle mercurial_ and git_ protocol requests. Each request is authenticated and logged together with IP address. - Build for speed and performance. You can make multiple pulls/pushes simultaneous. Proven to work with 1000s of repositories and users @@ -86,41 +86,41 @@ changeset statuses, and notification system. - Importing and syncing repositories from remote locations for GIT_, Mercurial_ and SVN. - Mako templates let's you customize the look and feel of the application. -- Beautiful diffs, annotations and source code browsing all colored by pygments. +- Beautiful diffs, annotations and source code browsing all colored by pygments. Raw diffs are made in git-diff format for both VCS systems, including GIT_ binary-patches - Mercurial_ and Git_ DAG graphs and yui-flot powered graphs with zooming and statistics to track activity for repositories - Admin interface with user/permission management. Admin activity journal, logs pulls, pushes, forks, registrations and other actions made by all users. -- Server side forks. It is possible to fork a project and modify it freely +- Server side forks. It is possible to fork a project and modify it freely without breaking the main repository. -- rst and markdown README support for repositories. +- rst and markdown README support for repositories. - Full text search powered by Whoosh on the source files, commit messages, and file names. Build in indexing daemons, with optional incremental index build (no external search servers required all in one application) -- Setup project descriptions/tags and info inside built in db for easy, non +- Setup project descriptions/tags and info inside built in db for easy, non file-system operations. -- Intelligent cache with invalidation after push or project change, provides +- Intelligent cache with invalidation after push or project change, provides high performance and always up to date data. - RSS / Atom feeds, gravatar support, downloadable sources as zip/tar/gz -- Optional async tasks for speed and performance using celery_ -- Backup scripts can do backup of whole app and send it over scp to desired - location +- Optional async tasks for speed and performance using celery_ +- Backup scripts can do backup of whole app and send it over scp to desired + location - Based on pylons / sqlalchemy / sqlite / whoosh / vcs - + Incoming / Plans ---------------- - Finer granular permissions per branch, or subrepo - Web based merges for pull requests - Tracking history for each lines in files -- Simple issue tracker +- Simple issue tracker - SSH based authentication with server side key management - Commit based built in wiki system - Gist server - More statistics and graph (global annotation + some more statistics) -- Other advancements as development continues (or you can of course make +- Other advancements as development continues (or you can of course make additions and or requests) License @@ -135,10 +135,10 @@ Listed bellow are various support resources that should help. .. note:: - + Please try to read the documentation before posting any issues, especially the **troubleshooting section** - + - Join the `Google group <http://groups.google.com/group/rhodecode>`_ and ask any questions. @@ -163,9 +163,9 @@ 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: +have sphinx_ installed you can install it via the command: ``easy_install sphinx``) - + .. _virtualenv: http://pypi.python.org/pypi/virtualenv .. _python: http://www.python.org/ .. _sphinx: http://sphinx.pocoo.org/ @@ -176,4 +176,4 @@ .. _git: http://git-scm.com/ .. _celery: http://celeryproject.org/ .. _Sphinx: http://sphinx.pocoo.org/ -.. _vcs: http://pypi.python.org/pypi/vcs \ No newline at end of file +.. _vcs: http://pypi.python.org/pypi/vcs
--- a/docs/changelog.rst Tue Feb 12 22:05:35 2013 +0100 +++ b/docs/changelog.rst Tue Feb 12 22:42:26 2013 +0100 @@ -4,6 +4,26 @@ Changelog ========= +1.5.3 (**2013-02-12**) +---------------------- + +news +++++ + +- IP restrictions now also enabled for IPv6 + +fixes ++++++ + +- fixed issues with private checkbox not always working +- fixed #746 unicodeDedode errors on feed controllers +- fixes issue #756 cleanup repos didn't properly compose paths of repos to be cleaned up. +- fixed cache invalidation issues together with vcs_full_cache option +- repo scan should skip directories with starting with '.' +- fixes for issue #731, update-repoinfo sometimes failed to update data when changesets + were initial commits +- recursive mode of setting permission skips private repositories + 1.5.2 (**2013-01-14**) ---------------------- @@ -932,4 +952,4 @@ - Disabled dirsize in file browser, it's causing nasty bug when dir renames occure. After vcs is fixed it'll be put back again. -- templating/css rewrites, optimized css. \ No newline at end of file +- templating/css rewrites, optimized css.
--- a/docs/installation_win.rst Tue Feb 12 22:05:35 2013 +0100 +++ b/docs/installation_win.rst Tue Feb 12 22:42:26 2013 +0100 @@ -5,154 +5,196 @@ ===================================== -RhodeCode step-by-step install Guide for Windows +RhodeCode step-by-step install Guide for Windows -Target OS: Windows XP SP3 32bit English (Clean installation) -+ All Windows Updates until 24-may-2012 +Target OS: Windows XP SP3 32bit English (Clean installation) ++ All Windows Updates until 24-may-2012 .. note:: - + This installation is for 32bit systems, for 64bit windows you might need - to download proper 64bit version of "Windows Installer" and Win32py - extensions + to download proper 64bit versions of the different packages(Windows Installer, Win32py extensions) + plus some extra tweaks. + These extra steps haven been marked as "64bit". + Tested on Windows Server 2008 R2 SP1, 9-feb-2013. + If you run into any 64bit related problems, please check these pages: + - http://blog.victorjabur.com/2011/06/05/compiling-python-2-7-modules-on-windows-32-and-64-using-msvc-2008-express/ + - http://bugs.python.org/issue7511 Step1 - Install Visual Studio 2008 Express ------------------------------------------ - -Optional: You can also install MingW, but VS2008 installation is easier + +Optional: You can also install MingW, but VS2008 installation is easier -Download "Visual C++ 2008 Express Edition with SP1" from: -http://www.microsoft.com/visualstudio/en-us/products/2008-editions/express -(if not found or relocated, google for "visual studio 2008 express" for -updated link) +Download "Visual C++ 2008 Express Edition with SP1" from: +http://www.microsoft.com/visualstudio/en-us/products/2008-editions/express +(if not found or relocated, google for "visual studio 2008 express" for +updated link) -You can also download full ISO file for offline installation, just -choose "All - Offline Install ISO image file" in the previous page and -choose "Visual C++ 2008 Express" when installing. - +You can also download full ISO file for offline installation, just +choose "All - Offline Install ISO image file" in the previous page and +choose "Visual C++ 2008 Express" when installing. .. note:: - Silverlight Runtime and SQL Server 2008 Express Edition are not - required, you can uncheck them + Using other versions of Visual Studio will lead to random crashes. + You must use Visual Studio 2008!" + +.. note:: + + Silverlight Runtime and SQL Server 2008 Express Edition are not + required, you can uncheck them + +.. note:: + + 64bit: You also need to install the Microsoft Windows SDK for .NET 3.5 SP1 (.NET 4.0 won't work). + Download from: http://www.microsoft.com/en-us/download/details.aspx?id=3138 + +.. note:: + + 64bit: You also need to copy and rename a .bat file to make the Visual C++ compiler work. + I am not sure why this is not necessary for 32bit. + Copy C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\vcvars64.bat to C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\amd64\vcvarsamd64.bat Step2 - Install Python ---------------------- Install Python 2.x.y (x >= 5) x86 version (32bit). DO NOT USE A 3.x version. -Download Python 2.x.y from: -http://www.python.org/download/ +Download Python 2.x.y from: +http://www.python.org/download/ -Choose "Windows Installer" (32bit version) not "Windows X86-64 -Installer". While writing this guide, the latest version was v2.7.3. -Remember the specific major and minor version installed, because it will -be needed in the next step. In this case, it is "2.7". +Choose "Windows Installer" (32bit version) not "Windows X86-64 +Installer". While writing this guide, the latest version was v2.7.3. +Remember the specific major and minor version installed, because it will +be needed in the next step. In this case, it is "2.7". +.. note:: + + 64bit: Just download and install the 64bit version of python. Step3 - Install Win32py extensions ---------------------------------- - -Download pywin32 from: -http://sourceforge.net/projects/pywin32/files/ + +Download pywin32 from: +http://sourceforge.net/projects/pywin32/files/ -- Click on "pywin32" folder -- Click on the first folder (in this case, Build 217, maybe newer when you try) -- Choose the file ending with ".win32-py2.x.exe" -> x being the minor - version of Python you installed (in this case, 7) - When writing this guide, the file was: - http://sourceforge.net/projects/pywin32/files/pywin32/Build%20217/pywin32-217.win32-py2.7.exe/download +- Click on "pywin32" folder +- Click on the first folder (in this case, Build 217, maybe newer when you try) +- Choose the file ending with ".win32-py2.x.exe" -> x being the minor + version of Python you installed (in this case, 7) + When writing this guide, the file was: + http://sourceforge.net/projects/pywin32/files/pywin32/Build%20217/pywin32-217.win32-py2.7.exe/download + .. note:: + + 64bit: Download and install the 64bit version. + At the time of writing you can find this at: + http://sourceforge.net/projects/pywin32/files/pywin32/Build%20218/pywin32-218.win-amd64-py2.7.exe/download Step4 - Python BIN ------------------ -Add Python BIN folder to the path +Add Python BIN folder to the path -You have to add the Python folder to the path, you can do it manually -(editing "PATH" environment variable) or using Windows Support Tools -that came preinstalled in Vista/7 and can be installed in Windows XP. +You have to add the Python folder to the path, you can do it manually +(editing "PATH" environment variable) or using Windows Support Tools +that came preinstalled in Vista/7 and can be installed in Windows XP. -- Using support tools on WINDOWS XP: - If you use Windows XP you can install them using Windows XP CD and - navigating to \SUPPORT\TOOLS. There, execute Setup.EXE (not MSI). +- Using support tools on WINDOWS XP: + If you use Windows XP you can install them using Windows XP CD and + navigating to \SUPPORT\TOOLS. There, execute Setup.EXE (not MSI). Afterwards, open a CMD and type:: - - SETX PATH "%PATH%;[your-python-path]" -M + + SETX PATH "%PATH%;[your-python-path]" -M - Close CMD (the path variable will be updated then) + Close CMD (the path variable will be updated then) -- Using support tools on WINDOWS Vista/7: +- Using support tools on WINDOWS Vista/7: Open a CMD and type:: - SETX PATH "%PATH%;[your-python-path]" /M + SETX PATH "%PATH%;[your-python-path]" /M - Please substitute [your-python-path] with your Python installation path. - Typically: C:\\Python27 + Please substitute [your-python-path] with your Python installation path. + Typically: C:\\Python27 Step5 - RhodeCode folder structure ---------------------------------- -Create a RhodeCode folder structure +Create a RhodeCode folder structure -This is only a example to install RhodeCode, you can of course change -it. However, this guide will follow the proposed structure, so please -later adapt the paths if you change them. My recommendation is to use -folders with NO SPACES. But you can try if you are brave... +This is only a example to install RhodeCode, you can of course change +it. However, this guide will follow the proposed structure, so please +later adapt the paths if you change them. My recommendation is to use +folders with NO SPACES. But you can try if you are brave... Create the following folder structure:: - C:\RhodeCode - C:\RhodeCode\Bin - C:\RhodeCode\Env - C:\RhodeCode\Repos + C:\RhodeCode + C:\RhodeCode\Bin + C:\RhodeCode\Env + C:\RhodeCode\Repos Step6 - Install virtualenv --------------------------- -Install Virtual Env for Python +Install Virtual Env for Python -Navigate to: http://www.virtualenv.org/en/latest/index.html#installation -Right click on "virtualenv.py" file and choose "Save link as...". -Download to C:\\RhodeCode (or whatever you want) -(the file is located at -https://raw.github.com/pypa/virtualenv/master/virtualenv.py) +Navigate to: http://www.virtualenv.org/en/latest/index.html#installation +Right click on "virtualenv.py" file and choose "Save link as...". +Download to C:\\RhodeCode (or whatever you want) +(the file is located at +https://raw.github.com/pypa/virtualenv/master/virtualenv.py) -Create a virtual Python environment in C:\\RhodeCode\\Env (or similar). To -do so, open a CMD (Python Path should be included in Step3), navigate -where you downloaded "virtualenv.py", and write:: +Create a virtual Python environment in C:\\RhodeCode\\Env (or similar). To +do so, open a CMD (Python Path should be included in Step3), navigate +where you downloaded "virtualenv.py", and write:: - python virtualenv.py C:\RhodeCode\Env + python virtualenv.py C:\RhodeCode\Env -(--no-site-packages is now the default behaviour of virtualenv, no need -to include it) +(--no-site-packages is now the default behaviour of virtualenv, no need +to include it) Step7 - Install RhodeCode ------------------------- -Finally, install RhodeCode +Finally, install RhodeCode + +Close previously opened command prompt/s, and open a Visual Studio 2008 +Command Prompt (**IMPORTANT!!**). To do so, go to Start Menu, and then open +"Microsoft Visual C++ 2008 Express Edition" -> "Visual Studio Tools" -> +"Visual Studio 2008 Command Prompt" + +.. note:: -Close previously opened command prompt/s, and open a Visual Studio 2008 -Command Prompt (**IMPORTANT!!**). To do so, go to Start Menu, and then open -"Microsoft Visual C++ 2008 Express Edition" -> "Visual Studio Tools" -> -"Visual Studio 2008 Command Prompt" + 64bit: For 64bit you need to modify the shortcut that is used to start the + Visual Studio 2008 Command Prompt. Use right-mouse click to open properties. + +Change commandline from:: + +%comspec% /k ""C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\vcvarsall.bat"" x86 + +to:: + +%comspec% /k ""C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\vcvarsall.bat"" amd64 + In that CMD (loaded with VS2008 PATHs) type:: - - cd C:\RhodeCode\Env\Scripts (or similar) - activate + + cd C:\RhodeCode\Env\Scripts (or similar) + activate -The prompt will change into "(Env) C:\\RhodeCode\\Env\\Scripts" or similar -(depending of your folder structure). Then type:: +The prompt will change into "(Env) C:\\RhodeCode\\Env\\Scripts" or similar +(depending of your folder structure). Then type:: - pip install rhodecode + pip install rhodecode -(long step, please wait until fully complete) +(long step, please wait until fully complete) Some warnings will appear, don't worry as they are normal. @@ -161,90 +203,90 @@ ----------------------------- -steps taken from http://packages.python.org/RhodeCode/setup.html +steps taken from http://packages.python.org/RhodeCode/setup.html -You have to use the same Visual Studio 2008 command prompt as Step7, so -if you closed it reopen it following the same commands (including the +You have to use the same Visual Studio 2008 command prompt as Step7, so +if you closed it reopen it following the same commands (including the "activate" one). When ready, just type:: - - cd C:\RhodeCode\Bin - paster make-config RhodeCode production.ini + + cd C:\RhodeCode\Bin + paster make-config RhodeCode production.ini -Then, you must edit production.ini to fit your needs (ip address, ip -port, mail settings, database, whatever). I recommend using NotePad++ -(free) or similar text editor, as it handles well the EndOfLine -character differences between Unix and Windows -(http://notepad-plus-plus.org/) +Then, you must edit production.ini to fit your needs (ip address, ip +port, mail settings, database, whatever). I recommend using NotePad++ +(free) or similar text editor, as it handles well the EndOfLine +character differences between Unix and Windows +(http://notepad-plus-plus.org/) -For the sake of simplicity lets run it with the default settings. After -your edits (if any), in the previous Command Prompt, type:: - - paster setup-rhodecode production.ini +For the sake of simplicity lets run it with the default settings. After +your edits (if any), in the previous Command Prompt, type:: -(this time a NEW database will be installed, you must follow a different -step to later UPGRADE to a newer RhodeCode version) + paster setup-rhodecode production.ini + +(this time a NEW database will be installed, you must follow a different +step to later UPGRADE to a newer RhodeCode version) -The script will ask you for confirmation about creating a NEW database, -answer yes (y) -The script will ask you for repository path, answer C:\\RhodeCode\\Repos -(or similar) -The script will ask you for admin username and password, answer "admin" -+ "123456" (or whatever you want) -The script will ask you for admin mail, answer "admin@xxxx.com" (or -whatever you want) +The script will ask you for confirmation about creating a NEW database, +answer yes (y) +The script will ask you for repository path, answer C:\\RhodeCode\\Repos +(or similar) +The script will ask you for admin username and password, answer "admin" ++ "123456" (or whatever you want) +The script will ask you for admin mail, answer "admin@xxxx.com" (or +whatever you want) -If you make some mistake and the script does not end, don't worry, start -it again. +If you make some mistake and the script does not end, don't worry, start +it again. Step9 - Running RhodeCode ------------------------- -In the previous command prompt, being in the C:\\RhodeCode\\Bin folder, +In the previous command prompt, being in the C:\\RhodeCode\\Bin folder, just type:: - - paster serve production.ini + + paster serve production.ini -Open yout web server, and go to http://127.0.0.1:5000 +Open yout web server, and go to http://127.0.0.1:5000 -It works!! :-) +It works!! :-) -Remark: -If it does not work first time, just Ctrl-C the CMD process and start it -again. Don't forget the "http://" in Internet Explorer +Remark: +If it does not work first time, just Ctrl-C the CMD process and start it +again. Don't forget the "http://" in Internet Explorer What this Guide does not cover: -- Installing Celery +- Installing Celery - Running RhodeCode as Windows Service. You can investigate here: - - - http://pypi.python.org/pypi/wsgisvc - - http://ryrobes.com/python/running-python-scripts-as-a-windows-service/ - - http://wiki.pylonshq.com/display/pylonscookbook/How+to+run+Pylons+as+a+Windows+service + + - http://pypi.python.org/pypi/wsgisvc + - http://ryrobes.com/python/running-python-scripts-as-a-windows-service/ + - http://wiki.pylonshq.com/display/pylonscookbook/How+to+run+Pylons+as+a+Windows+service - Using Apache. You can investigate here: - - https://groups.google.com/group/rhodecode/msg/c433074e813ffdc4 + - https://groups.google.com/group/rhodecode/msg/c433074e813ffdc4 Upgrading ========= - -Stop running RhodeCode + +Stop running RhodeCode Open a CommandPrompt like in Step7 (VS2008 path + activate) and type:: - - easy_install -U rhodecode - cd \RhodeCode\Bin + + easy_install -U rhodecode + cd \RhodeCode\Bin -{ backup your production.ini file now} :: +{ backup your production.ini file now} :: - paster make-config RhodeCode production.ini + paster make-config RhodeCode production.ini (check changes and update your production.ini accordingly) :: - + paster upgrade-db production.ini (update database) -Full steps in http://packages.python.org/RhodeCode/upgrade.html \ No newline at end of file +Full steps in http://packages.python.org/RhodeCode/upgrade.html
--- a/docs/setup.rst Tue Feb 12 22:05:35 2013 +0100 +++ b/docs/setup.rst Tue Feb 12 22:42:26 2013 +0100 @@ -8,14 +8,14 @@ Setting up RhodeCode -------------------- -First, you will need to create a RhodeCode configuration file. Run the +First, you will need to create a RhodeCode configuration file. Run the following command to do this:: - + paster make-config RhodeCode production.ini - This will create the file `production.ini` in the current directory. This - configuration file contains the various settings for RhodeCode, e.g proxy - port, email settings, usage of static files, cache, celery settings and + configuration file contains the various settings for RhodeCode, e.g proxy + port, email settings, usage of static files, cache, celery settings and logging. @@ -30,36 +30,36 @@ This will prompt you for a "root" path. This "root" path is the location where RhodeCode will store all of its repositories on the current machine. After -entering this "root" path ``setup-rhodecode`` will also prompt you for a username -and password for the initial admin account which ``setup-rhodecode`` sets +entering this "root" path ``setup-rhodecode`` will also prompt you for a username +and password for the initial admin account which ``setup-rhodecode`` sets up for you. setup process can be fully automated, example for lazy:: paster setup-rhodecode production.ini --user=marcink --password=secret --email=marcin@rhodecode.org --repos=/home/marcink/my_repos - + -- The ``setup-rhodecode`` command will create all of the needed tables and an - admin account. When choosing a root path you can either use a new empty +- The ``setup-rhodecode`` command will create all of the needed tables and an + admin account. When choosing a root path you can either use a new empty location, or a location which already contains existing repositories. If you - choose a location which contains existing repositories RhodeCode will simply - add all of the repositories at the chosen location to it's database. + choose a location which contains existing repositories RhodeCode will simply + add all of the repositories at the chosen location to it's database. (Note: make sure you specify the correct path to the root). - Note: the given path for mercurial_ repositories **must** be write accessible - for the application. It's very important since the RhodeCode web interface - will work without write access, but when trying to do a push it will + for the application. It's very important since the RhodeCode web interface + will work without write access, but when trying to do a push it will eventually fail with permission denied errors unless it has write access. You are now ready to use RhodeCode, to run it simply execute:: - + paster serve production.ini - -- This command runs the RhodeCode server. The web app should be available at the - 127.0.0.1:5000. This ip and port is configurable via the production.ini + +- This command runs the RhodeCode server. The web app should be available at the + 127.0.0.1:5000. This ip and port is configurable via the production.ini file created in previous step -- Use the admin account you created above when running ``setup-rhodecode`` +- Use the admin account you created above when running ``setup-rhodecode`` to login to the web app. -- The default permissions on each repository is read, and the owner is admin. +- The default permissions on each repository is read, and the owner is admin. Remember to update these if needed. - In the admin panel you can toggle ldap, anonymous, permissions settings. As well as edit more advanced options on users and repositories @@ -70,10 +70,10 @@ paster make-rcext production.ini This will create `rcextensions` package in the same place that your `ini` file -lives. With `rcextensions` it's possible to add additional mapping for whoosh, +lives. With `rcextensions` it's possible to add additional mapping for whoosh, stats and add additional code into the push/pull/create/delete repo hooks. For example for sending signals to build-bots such as jenkins. -Please see the `__init__.py` file inside `rcextensions` package +Please see the `__init__.py` file inside `rcextensions` package for more details. @@ -86,11 +86,11 @@ the box" feature of mercurial_ and you can use this to access any of the repositories that RhodeCode is hosting. See PublishingRepositories_) -RhodeCode repository structures are kept in directories with the same name +RhodeCode repository structures are kept in directories with the same name as the project. When using repository groups, each group is a subdirectory. This allows you to easily use ssh for accessing repositories. -In order to use ssh you need to make sure that your web-server and the users +In order to use ssh you need to make sure that your web-server and the users login accounts have the correct permissions set on the appropriate directories. (Note that these permissions are independent of any permissions you have set up using the RhodeCode web interface.) @@ -108,17 +108,17 @@ permissions as set up via the RhodeCode web interface, you can create an authentication hook to connect to the rhodecode db and runs check functions for permissions against that. - + Setting up Whoosh full text search ---------------------------------- Starting from version 1.1 the whoosh index can be build by using the paster command ``make-index``. To use ``make-index`` you must specify the configuration -file that stores the location of the index. You may specify the location of the -repositories (`--repo-location`). If not specified, this value is retrieved -from the RhodeCode database. This was required prior to 1.2. Starting from -version 1.2 it is also possible to specify a comma separated list of -repositories (`--index-only`) to build index only on chooses repositories +file that stores the location of the index. You may specify the location of the +repositories (`--repo-location`). If not specified, this value is retrieved +from the RhodeCode database. This was required prior to 1.2. Starting from +version 1.2 it is also possible to specify a comma separated list of +repositories (`--index-only`) to build index only on chooses repositories skipping any other found in repos location You may optionally pass the option `-f` to enable a full index rebuild. Without @@ -126,24 +126,24 @@ For an incremental index build use:: - paster make-index production.ini + paster make-index production.ini For a full index rebuild use:: - paster make-index production.ini -f + paster make-index production.ini -f building index just for chosen repositories is possible with such command:: - + paster make-index production.ini --index-only=vcs,rhodecode In order to do periodical index builds and keep your index always up to date. -It's recommended to do a crontab entry for incremental indexing. +It's recommended to do a crontab entry for incremental indexing. An example entry might look like this:: - - /path/to/python/bin/paster make-index /path/to/rhodecode/production.ini - + + /path/to/python/bin/paster make-index /path/to/rhodecode/production.ini + When using incremental mode (the default) whoosh will check the last modification date of each file and add it to be reindexed if a newer file is available. The indexing daemon checks for any removed files and removes them @@ -157,19 +157,19 @@ ----------------------- RhodeCode starting from version 1.1 supports ldap authentication. In order -to use LDAP, you have to install the python-ldap_ package. This package is +to use LDAP, you have to install the python-ldap_ package. This package is available via pypi, so you can install it by running using easy_install:: easy_install python-ldap - + using pip:: pip install python-ldap .. note:: - python-ldap requires some certain libs on your system, so before installing + python-ldap requires some certain libs on your system, so before installing it check that you have at least `openldap`, and `sasl` libraries. LDAP settings are located in admin->ldap section, @@ -232,12 +232,12 @@ No encryption Plain non encrypted connection - + LDAPS connection - Enable ldaps connection. It will likely require `Port`_ to be set to - a different value (standard LDAPS port is 636). When LDAPS is enabled + Enable ldaps connection. It will likely require `Port`_ to be set to + a different value (standard LDAPS port is 636). When LDAPS is enabled then `Certificate Checks`_ is required. - + START_TLS on LDAP connection START TLS connection @@ -245,7 +245,7 @@ Certificate Checks : optional How SSL certificates verification is handled - this is only useful when - `Enable LDAPS`_ is enabled. Only DEMAND or HARD offer full SSL security + `Enable LDAPS`_ is enabled. Only DEMAND or HARD offer full SSL security while the other options are susceptible to man-in-the-middle attacks. SSL certificates can be installed to /etc/openldap/cacerts so that the DEMAND or HARD options can be used with self-signed certificates or @@ -305,7 +305,7 @@ .. _Login Attribute: -Login Attribute : required +Login Attribute : required The LDAP record attribute that will be matched as the USERNAME or ACCOUNT used to connect to RhodeCode. This will be added to `LDAP Filter`_ for locating the User object. If `LDAP Filter`_ is specified as @@ -423,7 +423,7 @@ RewriteCond %{LA-U:REMOTE_USER} (.+) RewriteRule .* - [E=RU:%1] RequestHeader set X-Forwarded-User %{RU}e - </Location> + </Location> In order for RhodeCode to start using the forwarded username, you should set the following in the [app:main] section of your .ini file:: @@ -450,27 +450,27 @@ `url_pat` is the regular expression that will fetch issues from commit messages. Default regex will match issues in format of #<number> eg. #300. - -Matched issues will be replace with the link specified as `issue_server_link` + +Matched issues will be replace with the link specified as `issue_server_link` {id} will be replaced with issue id, and {repo} with repository name. -Since the # is striped `issue_prefix` is added as a prefix to url. -`issue_prefix` can be something different than # if you pass +Since the # is striped `issue_prefix` is added as a prefix to url. +`issue_prefix` can be something different than # if you pass ISSUE- as issue prefix this will generate an url in format:: - - <a href="https://myissueserver.com/example_repo/issue/300">ISSUE-300</a> + + <a href="https://myissueserver.com/example_repo/issue/300">ISSUE-300</a> Hook management --------------- Hooks can be managed in similar way to this used in .hgrc files. To access hooks setting click `advanced setup` on Hooks section of Mercurial -Settings in Admin. +Settings in Admin. There are 4 built in hooks that cannot be changed (only enable/disable by checkboxes on previos section). -To add another custom hook simply fill in first section with +To add another custom hook simply fill in first section with <name>.<hook_type> and the second one with hook path. Example hooks -can be found at *rhodecode.lib.hooks*. +can be found at *rhodecode.lib.hooks*. Changing default encoding @@ -488,7 +488,7 @@ ----------------- Since version 1.1 celery is configured by the rhodecode ini configuration files. -Simply set use_celery=true in the ini file then add / change the configuration +Simply set use_celery=true in the ini file then add / change the configuration variables inside the ini file. Remember that the ini files use the format with '.' not with '_' like celery. @@ -501,9 +501,9 @@ .. note:: - Make sure you run this command from the same virtualenv, and with the same + Make sure you run this command from the same virtualenv, and with the same user that rhodecode runs. - + HTTPS support ------------- @@ -511,7 +511,7 @@ - Set HTTP_X_URL_SCHEME in your http server headers, than rhodecode will recognize this headers and make proper https redirections -- Alternatively, change the `force_https = true` flag in the ini configuration +- Alternatively, change the `force_https = true` flag in the ini configuration to force using https, no headers are needed than to enable https @@ -526,39 +526,49 @@ #server 127.0.0.1:5001; #server 127.0.0.1:5002; } - + server { - listen 80; - server_name hg.myserver.com; + listen 443; + server_name rhodecode.myserver.com; access_log /var/log/nginx/rhodecode.access.log; error_log /var/log/nginx/rhodecode.error.log; + ssl on; + ssl_certificate rhodecode.myserver.com.crt; + ssl_certificate_key rhodecode.myserver.com.key; + + ssl_session_timeout 5m; + + ssl_protocols SSLv3 TLSv1; + ssl_ciphers DHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA:EDH-RSA-DES-CBC3-SHA:AES256-SHA:DES-CBC3-SHA:AES128-SHA:RC4-SHA:RC4-MD5; + ssl_prefer_server_ciphers on; + # uncomment if you have nginx with chunking module compiled # fixes the issues of having to put postBuffer data for large git - # pushes + # pushes #chunkin on; #error_page 411 = @my_411_error; #location @my_411_error { # chunkin_resume; #} - + # uncomment if you want to serve static files by nginx #root /path/to/installation/rhodecode/public; - + location / { try_files $uri @rhode; } - + location @rhode { proxy_pass http://rc; include /etc/nginx/proxy.conf; } - } - + } + Here's the proxy.conf. It's tuned so it will not timeout on long pushes or large pushes:: - + proxy_redirect off; proxy_set_header Host $host; proxy_set_header X-Url-Scheme $scheme; @@ -573,7 +583,7 @@ proxy_send_timeout 7200; proxy_read_timeout 7200; proxy_buffers 8 32k; - + Also, when using root path with nginx you might set the static files to false in the production.ini file:: @@ -595,24 +605,24 @@ <VirtualHost *:80> ServerName hg.myserver.com ServerAlias hg.myserver.com - + <Proxy *> Order allow,deny Allow from all </Proxy> - + #important ! #Directive to properly generate url (clone url) for pylons ProxyPreserveHost On - + #rhodecode instance ProxyPass / http://127.0.0.1:5000/ ProxyPassReverse / http://127.0.0.1:5000/ - + #to enable https use line below #SetEnvIf X-Url-Scheme https HTTPS=1 - - </VirtualHost> + + </VirtualHost> Additional tutorial @@ -628,7 +638,7 @@ ProxyPass http://127.0.0.1:5000/<someprefix> ProxyPassReverse http://127.0.0.1:5000/<someprefix> SetEnvIf X-Url-Scheme https HTTPS=1 - </Location> + </Location> Besides the regular apache setup you will need to add the following line into [app:main] section of your .ini file:: @@ -639,7 +649,7 @@ [filter:proxy-prefix] use = egg:PasteDeploy#prefix - prefix = /<someprefix> + prefix = /<someprefix> then change <someprefix> into your choosen prefix @@ -675,12 +685,12 @@ WSGIPassAuthorization On .. note:: - when running apache as root please add: `user=www-data group=www-data` + when running apache as root please add: `user=www-data group=www-data` into above configuration .. note:: - RhodeCode cannot be runned in multiprocess mode in apache, make sure - you don't specify `processes=num` directive in the config + Running RhodeCode in multiprocess mode in apache is not supported, + make sure you don't specify `processes=num` directive in the config Example wsgi dispatch script:: @@ -688,13 +698,13 @@ import os os.environ["HGENCODING"] = "UTF-8" os.environ['PYTHON_EGG_CACHE'] = '/home/web/rhodecode/.egg-cache' - + # sometimes it's needed to set the curent dir - os.chdir('/home/web/rhodecode/') + os.chdir('/home/web/rhodecode/') import site site.addsitedir("/home/web/rhodecode/pyenv/lib/python2.6/site-packages") - + from paste.deploy import loadapp from paste.script.util.logging_config import fileConfig @@ -722,4 +732,4 @@ .. _mercurial-server: http://www.lshift.net/mercurial-server.html .. _PublishingRepositories: http://mercurial.selenic.com/wiki/PublishingRepositories .. _Issues tracker: https://bitbucket.org/marcinkuzminski/rhodecode/issues -.. _google group rhodecode: http://groups.google.com/group/rhodecode \ No newline at end of file +.. _google group rhodecode: http://groups.google.com/group/rhodecode
--- a/docs/upgrade.rst Tue Feb 12 22:05:35 2013 +0100 +++ b/docs/upgrade.rst Tue Feb 12 22:42:26 2013 +0100 @@ -8,12 +8,12 @@ --------------------------------------- .. note:: - Firstly, it is recommended that you **always** perform a database and + Firstly, it is recommended that you **always** perform a database and configuration backup before doing an upgrade. - - (These directions will use '{version}' to note that this is the version of - Rhodecode that these files were used with. If backing up your RhodeCode - instance from version 1.3.6 to 1.4.0, the ``production.ini`` file would be + + (These directions will use '{version}' to note that this is the version of + Rhodecode that these files were used with. If backing up your RhodeCode + instance from version 1.3.6 to 1.4.0, the ``production.ini`` file would be backed up to ``production.ini.1-3-6``.) @@ -34,7 +34,7 @@ pip freeze -will list all packages installed in the current environment. If Rhodecode +will list all packages installed in the current environment. If Rhodecode isn't listed, change virtual environments to your venv location:: source /opt/rhodecode-venv/bin/activate @@ -50,11 +50,11 @@ Then run the following command from the installation directory:: - + paster make-config RhodeCode production.ini - + This will display any changes made by the new version of RhodeCode to your -current configuration. It will try to perform an automerge. It's recommended +current configuration. It will try to perform an automerge. It's recommended that you re-check the content after the automerge. .. note:: @@ -62,7 +62,7 @@ caused by missing params added in new versions. -It is also recommended that you rebuild the whoosh index after upgrading since +It is also recommended that you rebuild the whoosh index after upgrading since the new whoosh version could introduce some incompatible index changes. Please Read the changelog to see if there were any changes to whoosh. @@ -70,12 +70,20 @@ The final step is to upgrade the database. To do this simply run:: paster upgrade-db production.ini - + This will upgrade the schema and update some of the defaults in the database, -and will always recheck the settings of the application, if there are no new +and will always recheck the settings of the application, if there are no new options that need to be set. -You may find it helpful to clear out your log file so that new errors are + +.. note:: + DB schema upgrade library has some limitations and can sometimes fail if you try to + upgrade from older major releases. In such case simply run upgrades sequentially, eg. + upgrading from 1.2.X to 1.5.X should be done like that: 1.2.X. > 1.3.X > 1.4.X > 1.5.X + You can always specify what version of RhodeCode you want to install for example in pip + `pip install RhodeCode==1.3.6` + +You may find it helpful to clear out your log file so that new errors are readily apparent:: echo > rhodecode.log @@ -92,7 +100,7 @@ If you're using Celery, make sure you restart all instances of it after upgrade. -.. _virtualenv: http://pypi.python.org/pypi/virtualenv +.. _virtualenv: http://pypi.python.org/pypi/virtualenv .. _python: http://www.python.org/ .. _mercurial: http://mercurial.selenic.com/ .. _celery: http://celeryproject.org/
--- a/docs/usage/general.rst Tue Feb 12 22:05:35 2013 +0100 +++ b/docs/usage/general.rst Tue Feb 12 22:42:26 2013 +0100 @@ -11,9 +11,17 @@ Currently when admin/owner deletes a repository, RhodeCode does not physically delete a repository from filesystem, it renames it in a special way so it's not possible to push,clone or access repository. It's worth a notice that, -even if someone will be given administrative access to RhodeCode and will +even if someone will be given administrative access to RhodeCode and will delete a repository You can easy restore such action by restoring `rm__<date>` -from the repository name, and internal repository storage (.hg/.git) +from the repository name, and internal repository storage (.hg/.git). There +is also a special command for cleaning such archived repos:: + + paster cleanup-repos --older-than=30d production.ini + +This command will scan for archived repositories that are older than 30d, +display them and ask if you want to delete them (there's a --dont-ask flag also) +If you host big amount of repositories with forks that are constantly deleted +it's recommended that you run such command via crontab. Follow current branch in file view ---------------------------------- @@ -31,7 +39,7 @@ only show the range between the first and last checkbox (no cherry pick). Clicking more than one checkbox will activate a link in top saying `Show selected changes <from-rev> -> <to-rev>` clicking this will bring -compare view +compare view. In this view also it's possible to switch to combined compare. Compare view is also available from the journal on pushes having more than one changeset @@ -44,21 +52,21 @@ can change. example:: - + #before http://server.com/repo_name # after insertion to test_group group the url will be http://server.com/test_group/repo_name - + This can be an issue for build systems and any other hardcoded scripts, moving -repository to a group leads to a need for changing external systems. To -overcome this RhodeCode introduces a non changable replacement url. It's +repository to a group leads to a need for changing external systems. To +overcome this RhodeCode introduces a non changable replacement url. It's simply an repository ID prefixed with `_` above urls are also accessible as:: http://server.com/_<ID> - + Since ID are always the same moving the repository will not affect such url. -the _<ID> syntax can be used anywhere in the system so urls with repo_name +the _<ID> syntax can be used anywhere in the system so urls with repo_name for changelogs, files and other can be exchanged with _<ID> syntax. @@ -71,7 +79,7 @@ Mails are also sent for code comments. If someone comments on a changeset -mail is sent to all participants, the person who commited the changeset +mail is sent to all participants, the person who commited the changeset (if present in RhodeCode), and to all people mentioned with @mention system. @@ -96,12 +104,12 @@ .. note:: - - - *`svn -> hg` cloning requires `hgsubversion` library to be installed.* + + * `svn -> hg` cloning requires `hgsubversion` library to be installed.* If you need to clone repositories that are protected via basic auth, you -might pass the url with stored credentials inside eg. -`http://user:passw@remote.server/repo, RhodeCode will try to login and clone +might pass the url with stored credentials inside eg. +`http://user:passw@remote.server/repo`, RhodeCode will try to login and clone using given credentials. Please take a note that they will be stored as -plaintext inside the database. RhodeCode will remove auth info when showing the +plaintext inside the database. RhodeCode will remove auth info when showing the clone url in summary page.
--- a/docs/usage/troubleshooting.rst Tue Feb 12 22:05:35 2013 +0100 +++ b/docs/usage/troubleshooting.rst Tue Feb 12 22:42:26 2013 +0100 @@ -7,23 +7,23 @@ :Q: **Missing static files?** :A: Make sure either to set the `static_files = true` in the .ini file or - double check the root path for your http setup. It should point to + double check the root path for your http setup. It should point to for example: /home/my-virtual-python/lib/python2.6/site-packages/rhodecode/public - -| + +| :Q: **Can't install celery/rabbitmq?** :A: Don't worry RhodeCode works without them too. No extra setup is required. Try out great celery docs for further help. | - + :Q: **Long lasting push timeouts?** :A: Make sure you set a longer timeouts in your proxy/fcgi settings, timeouts are caused by https server and not RhodeCode. - -| + +| :Q: **Large pushes timeouts?** :A: Make sure you set a proper max_body_size for the http server. Very often @@ -46,7 +46,7 @@ :Q: **How i use hooks in RhodeCode?** :A: It's easy if they are python hooks just use advanced link in hooks section in Admin panel, that works only for Mercurial. If you want to use githooks, - just install proper one in repository eg. create file in + just install proper one in repository eg. create file in `/gitrepo/hooks/pre-receive`. You can also use RhodeCode-extensions to connect to callback hooks, for both Git and Mercurial. @@ -55,7 +55,19 @@ :Q: **RhodeCode is slow for me, how can i make it faster?** :A: See the :ref:`performance` section -For further questions search the `Issues tracker`_, or post a message in the +| + +:Q: **UnicodeDecodeError on Apache mod_wsgi** +:A: Please read: https://docs.djangoproject.com/en/dev/howto/deployment/wsgi/modwsgi/#if-you-get-a-unicodeencodeerror + +| + +:Q: **Requests hanging on Windows** +:A: Please try out with disabled Antivirus software, there are some known problems with Eset Anitivirus. Make sure + you have installed latest windows patches (especially KB2789397) + + +For further questions search the `Issues tracker`_, or post a message in the `google group rhodecode`_ .. _virtualenv: http://pypi.python.org/pypi/virtualenv @@ -67,4 +79,4 @@ .. _mercurial-server: http://www.lshift.net/mercurial-server.html .. _PublishingRepositories: http://mercurial.selenic.com/wiki/PublishingRepositories .. _Issues tracker: https://bitbucket.org/marcinkuzminski/rhodecode/issues -.. _google group rhodecode: http://groups.google.com/group/rhodecode \ No newline at end of file +.. _google group rhodecode: http://groups.google.com/group/rhodecode