GET_SOURCES.md 4.61 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13
<table style="border-collapse: collapse; border: none;">
  <tr style="border-collapse: collapse; border: none;">
    <td style="border-collapse: collapse; border: none;">
      <a href="http://www.openairinterface.org/">
         <img src="./images/oai_final_logo.png" alt="" border=3 height=50 width=150>
         </img>
      </a>
    </td>
    <td style="border-collapse: collapse; border: none; vertical-align: center;">
      <b><font size = "5">The OpenAirInterface repository: the sources</font></b>
    </td>
  </tr>
</table>
14 15 16 17 18

The OpenAirInterface software can be obtained from our gitLab
server. You will need a git client to get the sources. The repository
is currently used for main developments.

19
# Prerequisites
20 21 22 23 24 25 26 27

You need to install the subversion/git using the following commands:

```shell
sudo apt-get update
sudo apt-get install subversion git
```

28
# Using EURECOM Gitlab
29 30 31 32 33

The [openairinterface5g repository](https://gitlab.eurecom.fr/oai/openairinterface5g.git)
holds the source code for (eNB RAN + UE RAN).

For legal issues (licenses), the core network (EPC) source code is now moved away from
34
the above openairinterface5g git repository.
35

36 37 38 39 40 41 42 43 44
*  A very old version of the EPC is located under the same GitLab Eurecom server (splitted into 2 Git repos):
   *  [openair-cn](https://gitlab.eurecom.fr/oai/openair-cn.git) with apache license
   *  [xtables-addons-oai](https://gitlab.eurecom.fr/oai/xtables-addons-oai.git) with GPL license
   *  **These repositories are no more maintained.**
*  A more recent version is available under our GitHub domain:
   *  [OAI GitHub openair-cn](https://github.com/OPENAIRINTERFACE/openair-cn)
   *  Check its wiki pages for more details

Configure git with your name/email address (only important if you are developer and want to contribute/push code to Git Repository):
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62

```shell
git config --global user.name "Your Name"
git config --global user.email "Your email address"
```

- Add a certificate from gitlab.eurecom.fr to your Ubuntu 14.04 installation:

```shell
echo -n | openssl s_client -showcerts -connect gitlab.eurecom.fr:443 2>/dev/null | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' | sudo tee -a /etc/ssl/certs/ca-certificates.crt
```

- Disable certificate check completely if you do not have root access to /etc/ssl directory

```shell
git config --global http.sslverify false
```

63
## In order to clone the Git repository (for OAI Users without login to gitlab server)
64

65
Cloning RAN repository (eNB RAN + UE RAN):
66 67 68 69 70

```shell
git clone https://gitlab.eurecom.fr/oai/openairinterface5g.git
```

71
## In order to contribute to the Git RAN repository (for OAI Developers/admins with login to gitlab server)
72

73
Please send email to [contact@openairinterface.org](mailto:contact@openairinterface.org) to be added to the repository
74
as a developer (only important for users who want to commit code to the repository). If
75
you do not have account on gitlab.eurecom.fr, please register yourself to gitlab.eurecom.fr and provide the identifiant in the email.
76

77
* Clone with using ssh keys:
78
   * You will need to put your ssh keys in https://gitlab.eurecom.fr/profile/keys
79
     to access to the git repo. Once that is done, clone the git repository using:
80
   * `git clone git@gitlab.eurecom.fr:oai/openairinterface5g.git`
81
* Clone with user name/password prompt:
82 83 84 85
   * `git clone https://YOUR_USERNAME@gitlab.eurecom.fr/oai/openairinterface5g.git`
   * `git clone https://YOUR_USERNAME@gitlab.eurecom.fr/oai/openair-cn.git`
   * `git clone https://YOUR_USERNAME@gitlab.eurecom.fr/oai/xtables-addons-oai.git` (optional, openair-cn build script can do it for you)

86
# Which branch to checkout?
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109

On the RAN side:

* **master**: This branch is targeted for the user community. Since January 2019, it is also subject to a Continuous Integration process. The update frequency is about once every 2-3 months. We are also performing bug fixes on this branch.
* **develop**: This branch contains recent commits that are tested on our CI test bench. The update frequency is about once a week.

Please see the work flow and policies page :

https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/oai-policies-home

you can find the latest stable tag release here :

https://gitlab.eurecom.fr/oai/openairinterface5g/tags

The tag naming conventions are :

- On `master` branch: **v1.`x`.`y`** where
  * `x` is the minor release number, incremented every 2-3 months when we are merging `develop` into `master` branch.
  * `y` is the maintenance number, starting at 0 when we do a minor release and being incremented when a bug fix is incorporated into `master` branch.
- On `develop` branch **`yyyy`.w`xx`**
  * `yyyy` is the calendar year
  * `xx` the week number within the year