8460: Merge branch 'master' into 8460-websocket-go
[arvados.git] / doc / user / tutorials / add-new-repository.html.textile.liquid
1 ---
2 layout: default
3 navsection: userguide
4 title: Adding a new Arvados git repository
5 ...
6
7 Arvados repositories are managed through the Git revision control system. You can use these repositories to store your crunch scripts and run them in the arvados cluster.
8
9 {% include 'tutorial_expectations' %}
10
11 h2. Setting up Git
12
13 Before you start using Git and arvados repositories, you should do some basic configuration (you only need to do this the first time):
14
15 <notextile>
16 <pre><code>~$ <span class="userinput">git config --global user.name "Your Name"</span>
17 ~$ <span class="userinput">git config --global user.email $USER@example.com</span></code></pre>
18 </notextile>
19
20 h2. Add "tutorial" repository
21
22 On the Arvados Workbench, click on the dropdown menu icon <span class="fa fa-lg fa-user"></span> <span class="caret"></span> in the upper right corner of the top navigation menu to access the user settings menu, and click on the menu item *Repositories*.
23
24 In the *Repositories* page, you will see the *Add new repository* button.
25
26 !{display: block;margin-left: 25px;margin-right: auto;}{{ site.baseurl }}/images/repositories-panel.png!
27
28 Click the *Add new Repository* button to open the popup to add a new arvados repository. You will see a text box where you can enter the name of the repository. Enter *tutorial* in this text box and click on *Create*.
29
30 {% include 'notebox_begin' %}
31 The name you enter here must begin with a letter and can only contain alphanumeric characters.
32 {% include 'notebox_end' %}
33
34 !{display: block;margin-left: 25px;margin-right: auto;border:1px solid lightgray;}{{ site.baseurl }}/images/add-new-repository.png!
35
36 This will create a new repository with the name @$USER/tutorial@. It can be accessed using the URL <notextile><code>https://git.{{ site.arvados_api_host }}/$USER/tutorial.git</code></notextile> or <notextile><code>git@git.{{ site.arvados_api_host }}:$USER/tutorial.git</code></notextile>
37
38 Back in the *Repositories* page, you should see the @$USER/tutorial@ repository listed in the name column with these URLs.
39
40 !{display: block;margin-left: 25px;margin-right: auto;}{{ site.baseurl }}/images/added-new-repository.png!
41
42 You are now ready to use this *tutorial* repository to run your crunch scripts.