docs: better docs, mv doxygen to sphinx
[vpp.git] / docs / gettingstarted / installing / ubuntu.rst
1 .. _ubuntu:
2
3 .. toctree::
4
5 Ubuntu - Setup the FD.io Repository
6 ===================================
7
8 Choose one of the following releases to install.
9
10 Update the OS
11 -----------------------
12
13 It is a good idea to first update and upgrade the OS before starting; run the
14 following command to update the OS:
15
16 .. code-block:: console
17
18     apt-get update
19
20
21 Point to the Repository
22 -----------------------------------
23
24 Create a file **/etc/apt/sources.list.d/99fd.io.list** with contents that point to
25 the version needed. The contents needed are shown below.
26
27 .. _install_vpp:
28
29 VPP latest Release
30 ^^^^^^^^^^^^^^^^^^^
31
32 Create the file **/etc/apt/sources.list.d/99fd.io.list** that contain the following contents:
33
34 .. code-block:: console
35
36    deb [trusted=yes] https://packagecloud.io/fdio/release/ubuntu bionic main
37
38 Get the key:
39
40 .. code-block:: console
41
42   curl -L https://packagecloud.io/fdio/release/gpgkey | sudo apt-key add -
43
44 VPP master Branch
45 ^^^^^^^^^^^^^^^^^^^^
46
47 Create the file **/etc/apt/sources.list.d/99fd.io.list** that contain the following contents:
48
49 .. code-block:: console
50
51    deb [trusted=yes] https://packagecloud.io/fdio/master/ubuntu bionic main
52
53 Get the key:
54
55 .. code-block:: console
56
57   curl -L https://packagecloud.io/fdio/master/gpgkey | sudo apt-key add -
58
59
60 Install the Mandatory Packages
61 ===============================
62
63 Install the mandatory packages by running the following commands:
64
65 .. code-block:: console
66
67   sudo apt-get update
68   sudo apt-get install vpp vpp-plugin-core vpp-plugin-dpdk
69
70
71 Install the Optional Packages
72 ==============================
73
74 Install the optional packages by running the following command:
75
76 .. code-block:: console
77
78   sudo apt-get install vpp-api-python python3-vpp-api vpp-dbg vpp-dev
79
80
81 Uninstall the Packages
82 ======================
83
84 Uninstall the  packages by running the following command:
85
86 .. code-block:: console
87
88   sudo apt-get remove --purge "vpp*"