Show More
@@ -1,85 +1,88 b'' | |||||
1 | .. _install-tools: |
|
1 | .. _install-tools: | |
2 |
|
2 | |||
3 | |RCT| Installation |
|
3 | |RCT| Installation | |
4 | ------------------ |
|
4 | ------------------ | |
5 |
|
5 | |||
6 | As of |RCE| 3.4.1 |RCT| is installed automatically on the server with |RCE|. You |
|
6 | As of |RCE| 3.4.1 |RCT| is installed automatically on the server with |RCE|. You | |
7 | do not need to install |RCT| on the server, but you will need to install them |
|
7 | do not need to install |RCT| on the server, but you will need to install them | |
8 | on machines that need remote access. The tools are linked to the instance |
|
8 | on machines that need remote access. The tools are linked to the instance | |
9 | folder, for example :file:`~/.rccontrol/{instance-id}/profile/bin` |
|
9 | folder, for example :file:`~/.rccontrol/{instance-id}/profile/bin` | |
10 |
|
10 | |||
11 | You can list the available tools using the following example, and the valid |
|
11 | You can list the available tools using the following example, and the valid | |
12 | tools options are those which correspond with those in the :ref:`rc-tools` |
|
12 | tools options are those which correspond with those in the :ref:`rc-tools` | |
13 | section. |
|
13 | section. | |
14 |
|
14 | |||
15 | .. code-block:: bash |
|
15 | .. code-block:: bash | |
16 |
|
16 | |||
17 | $ ls ~/.rccontrol/enterprise-4/profile/bin/ |
|
17 | $ ls ~/.rccontrol/enterprise-4/profile/bin/ | |
18 |
|
18 | |||
19 | gen_js_i18n rhodecode-cleanup-gists rhodecode-tools svnrdump |
|
19 | gen_js_i18n rhodecode-cleanup-gists rhodecode-tools svnrdump | |
20 | gen_js_routes rhodecode-cleanup-repos supervisorctl svnserve |
|
20 | gen_js_routes rhodecode-cleanup-repos supervisorctl svnserve | |
21 | git rhodecode-config supervisord svnsync |
|
21 | git rhodecode-config supervisord svnsync | |
22 | gunicorn rhodecode-extensions svn svnversion |
|
22 | gunicorn rhodecode-extensions svn svnversion | |
23 | hg rhodecode-gist svnadmin vcsserver |
|
23 | hg rhodecode-gist svnadmin vcsserver | |
24 | paster rhodecode-index svndumpfilter |
|
24 | paster rhodecode-index svndumpfilter | |
25 | rc-server rhodecode-list-instances svnlook |
|
25 | rc-server rhodecode-list-instances svnlook | |
26 | rhodecode-api rhodecode-setup-config svnmucc |
|
26 | rhodecode-api rhodecode-setup-config svnmucc | |
27 |
|
27 | |||
28 | You can then use the tools as described in the :ref:`rc-tools` section using the |
|
28 | You can then use the tools as described in the :ref:`rc-tools` section using the | |
29 | following example: |
|
29 | following example: | |
30 |
|
30 | |||
31 | .. code-block:: bash |
|
31 | .. code-block:: bash | |
32 |
|
32 | |||
33 | # Running the indexer |
|
33 | # Running the indexer | |
34 | $ ~/.rccontrol/enterprise-1/profile/bin/rhodecode-index \ |
|
34 | $ ~/.rccontrol/enterprise-1/profile/bin/rhodecode-index \ | |
35 | --instance-name=enterprise-1 |
|
35 | --instance-name=enterprise-1 | |
36 |
|
36 | |||
37 | # Cleaning up gists |
|
37 | # Cleaning up gists | |
38 | $ ~/.rccontrol/enterprise-4/profile/bin/rhodecode-cleanup-gists \ |
|
38 | $ ~/.rccontrol/enterprise-4/profile/bin/rhodecode-cleanup-gists \ | |
39 | --instance-name=enterprise-4 |
|
39 | --instance-name=enterprise-4 | |
40 |
|
40 | |||
41 | Scanning for gists in /home/brian/repos/.rc_gist_store... |
|
41 | Scanning for gists in /home/brian/repos/.rc_gist_store... | |
42 | preparing to remove [1] found gists |
|
42 | preparing to remove [1] found gists | |
43 |
|
43 | |||
44 | Installing |RCT| |
|
44 | Installing |RCT| | |
45 | ^^^^^^^^^^^^^^^^ |
|
45 | ^^^^^^^^^^^^^^^^ | |
46 |
|
46 | |||
47 | |RCT| enable you to automate many of the most common |RCE| functions through |
|
47 | |RCT| enable you to automate many of the most common |RCE| functions through | |
48 | the API. Installing them on a local machine lets you carry out maintenance on |
|
48 | the API. Installing them on a local machine lets you carry out maintenance on | |
49 | the server remotely. Once installed you can use them to index your |repos| |
|
49 | the server remotely. Once installed you can use them to index your |repos| | |
50 | to setup full-text search, strip commits, or install RhodeCode Extensions for |
|
50 | to setup full-text search, strip commits, or install RhodeCode Extensions for | |
51 | additional functionality. |
|
51 | additional functionality. | |
52 |
|
52 | |||
53 | For more detailed instructions about using |RCT| for indexing and full-text |
|
53 | For more detailed instructions about using |RCT| for indexing and full-text | |
54 | search, see :ref:`indexing-ref` |
|
54 | search, see :ref:`indexing-ref` | |
55 |
|
55 | |||
56 | To install |RCT|, use the following steps: |
|
56 | To install |RCT|, use the following steps: | |
57 |
|
57 | |||
58 | 1. Set up a ``virtualenv`` on your local machine, see virtualenv_ instructions |
|
58 | 1. Set up a ``virtualenv`` on your local machine, see virtualenv_ instructions | |
59 | here. |
|
59 | here. | |
60 | 2. Install |RCT| using pip. Full url with token is available at https://rhodecode.com/u/#rhodecode-tools |
|
60 | 2. Install |RCT| using pip. All downloadable versions of |RCT| are available at: | |
61 |
` |
|
61 | `https://code.rhodecode.com/rhodecode-tools-ce/artifacts` | |
62 |
|
62 | |||
|
63 | Example installation:: | |||
|
64 | ||||
|
65 | pip install -I https://code.rhodecode.com/rhodecode-tools-ce/artifacts/download/0-10ac93f4-bb7d-4b97-baea-68110743dd5a.tar.gz | |||
63 |
|
66 | |||
64 | Once |RCT| is installed using these steps there are a few extra |
|
67 | Once |RCT| is installed using these steps there are a few extra | |
65 | configuration changes you can make. These are explained in more detail in the |
|
68 | configuration changes you can make. These are explained in more detail in the | |
66 | :ref:`indexing-ref` section, and the :ref:`rc-tools` section. |
|
69 | :ref:`indexing-ref` section, and the :ref:`rc-tools` section. | |
67 |
|
70 | |||
68 | .. code-block:: bash |
|
71 | .. code-block:: bash | |
69 |
|
72 | |||
70 | # Create a virtualenv |
|
73 | # Create a virtualenv | |
71 | brian@ubuntu:~$ virtualenv venv |
|
74 | brian@ubuntu:~$ virtualenv venv | |
72 | New python executable in venv/bin/python |
|
75 | New python executable in venv/bin/python | |
73 | Installing setuptools, pip...done. |
|
76 | Installing setuptools, pip...done. | |
74 |
|
77 | |||
75 | # Activate the virtualenv |
|
78 | # Activate the virtualenv | |
76 | brian@ubuntu:~$ . venv/bin/activate |
|
79 | brian@ubuntu:~$ . venv/bin/activate | |
77 |
|
80 | |||
78 | # Install RhodeCode Tools inside the virtualenv, full url with token is available at https://rhodecode.com/u/#rhodecode-tools |
|
81 | # Install RhodeCode Tools inside the virtualenv, full url with token is available at https://rhodecode.com/u/#rhodecode-tools | |
79 | $ pip install -I https://dls.rhodecode.com/dls/<token>/rhodecode-tools/latest |
|
82 | $ pip install -I https://dls.rhodecode.com/dls/<token>/rhodecode-tools/latest | |
80 |
|
83 | |||
81 | # Check the installation |
|
84 | # Check the installation | |
82 | $ rhodecode-tools --help |
|
85 | $ rhodecode-tools --help | |
83 |
|
86 | |||
84 | .. _virtualenv: https://virtualenv.pypa.io/en/latest/index.html |
|
87 | .. _virtualenv: https://virtualenv.pypa.io/en/latest/index.html | |
85 |
|
88 |
General Comments 0
You need to be logged in to leave comments.
Login now