##// END OF EJS Templates
docs(dev): updated dev docs
super-admin -
Show More
@@ -4,19 +4,39 b''
4 Setup of Development env
4 Setup of Development env
5 ========================
5 ========================
6
6
7
7 These instructions are meant for developing RhodeCode from source code.
8 To setup a development environment with all needed services for development follow the below actions:
8 To setup a development environment with all needed services for development follow the below actions:
9
9
10
10
11 define dev workspace home
12 +++++++++++++++++++++++++
13
14 Setup env variable WORKSPACE_HOME to your absolute path where you repositories for dev are stored. e.g
15
16 example:
17
18 `WORKSPACE_HOME=/media/psf/Home/workspace`
19
20 Set this on bash:
21
22 .. code-block:: bash
23
24 export WORKSPACE_HOME=/media/psf/Home/workspace
25
26
11 get rcstack & docker
27 get rcstack & docker
12 ++++++++++++++++++++
28 ++++++++++++++++++++
13
29
14 To quickly get and install rcstack run this command
30 To quickly get and install latest rcstack run this command
15
31
16 .. code-block:: bash
32 .. code-block:: bash
17
33
18 mkdir rhodecode-docker && cd rhodecode-docker
34 # create the rhodecode-docker dir, and cd into it
19 curl -L -s -o rcstack https://dls.rhodecode.com/get-rcstack && chmod +x rcstack
35 mkdir -p $WORKSPACE_HOME/rhodecode-docker && cd $WORKSPACE_HOME/rhodecode-docker
36
37 # get latest rcstack
38 curl -L -s -o rcstack https://code.rhodecode.com/rhodecode-enterprise-docker/raw/master/scripts/rcstack/rcstack && chmod +x rcstack
39
20 ./rcstack init
40 ./rcstack init
21
41
22
42
@@ -35,26 +55,26 b' Previously used `./rcstack init` command will setup docker, and bootstrap the en'
35 Obtain source code
55 Obtain source code
36 ++++++++++++++++++
56 ++++++++++++++++++
37
57
38 Please clone the following repositories at the same level as :file:`rhodecode-docker` dir is created
39
58
40 .. code-block:: bash
59 Please clone the following repositories into the WORKSPACE_HOME directory
41
60
42 hg clone https://code.rhodecode.com/internal/rhodecode-vcsserver
61 For CE development:
43 hg clone https://code.rhodecode.com/internal/rhodecode-enterprise-ce
44 hg clone https://code.rhodecode.com/internal/rhodecode-enterprise-ee
45
62
63 .. code-block:: bash
46
64
47 Setup env variable WORKSPACE_HOME to your absolute path where you repositories for dev are stored. e.g
65 hg clone https://code.rhodecode.com/rhodecode-vcsserver
48
66 hg clone https://code.rhodecode.com/rhodecode-enterprise-ce
49 example:
67 # make a dummy repo without source code
68 mkdir rhodecode-enterprise-ee
50
69
51 `WORKSPACE_HOME=/media/psf/Home/workspace`
52
70
53 Set this on bash:
71 for EE development:
54
72
55 .. code-block:: bash
73 .. code-block:: bash
56
74
57 export WORKSPACE_HOME=/media/psf/Home/workspace
75 hg clone https://code.rhodecode.com/internal/rhodecode-vcsserver
76 hg clone https://code.rhodecode.com/internal/rhodecode-enterprise-ce
77 hg clone https://code.rhodecode.com/internal/rhodecode-enterprise-ee
58
78
59
79
60 Finally this is the structure you should get:
80 Finally this is the structure you should get:
@@ -88,6 +108,13 b' To start developing we need few services to run, we can run this using `dev-env`'
88 ./dev-tools dev-env
108 ./dev-tools dev-env
89
109
90
110
111 .. note::
112
113 There's an option to run dev version of each of the service, e.g if ssh or svn should be tested it can be run like
114 ./dev-tools ssh
115 ./dev-tools svn
116
117
91 You can check the status of services by running
118 You can check the status of services by running
92
119
93 .. code-block:: bash
120 .. code-block:: bash
General Comments 0
You need to be logged in to leave comments. Login now