Mercurial > libervia-backend

comparison doc/installation.rst @ 3563:267e4987b58b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: fix remaining SàT references/typos + add `libervia-cli` missing commands
author Goffi <goffi@goffi.org>
date Fri, 11 Jun 2021 09:21:41 +0200
parents d8581c83fef3
children df836d6f9c8a
comparison
equal deleted inserted replaced
3562:9f599ccbea4e 3563:267e4987b58b
43 $ cd 43 $ cd
44 44
45 And enter the following commands (here we install Libervia with SVG support, which is needed to 45 And enter the following commands (here we install Libervia with SVG support, which is needed to
46 display SVG avatars on some frontends):: 46 display SVG avatars on some frontends)::
47 47
48 $ python3 -m venv sat 48 $ python3 -m venv libervia
49 $ source sat/bin/activate 49 $ source libervia/bin/activate
50 $ pip install -U pip wheel 50 $ pip install -U pip wheel
51 $ pip install -r requirements.txt 51 $ pip install -r requirements.txt
52 52
53 Don't worry if you see the following message, Libervia should work anyway:: 53 Don't worry if you see the following message, Libervia should work anyway::
54 54
57 After installing Libervia, you need to install the media:: 57 After installing Libervia, you need to install the media::
58 58
59 $ cd 59 $ cd
60 $ hg clone https://repos.goffi.org/sat_media 60 $ hg clone https://repos.goffi.org/sat_media
61 61
62 then, create the directory ``~/.config/sat``:: 62 then, create the directory ``~/.config/libervia``::
63 63
64 $ mkdir -p ~/.config/sat 64 $ mkdir -p ~/.config/libervia
65 65
66 and the file ``~/.config/sat/libervia.conf`` containing: 66 and the file ``~/.config/libervia/libervia.conf`` containing:
67 67
68 .. sourcecode:: cfg 68 .. sourcecode:: cfg
69 69
70 [DEFAULT] 70 [DEFAULT]
71 media_dir = ~/sat_media 71 media_dir = ~/sat_media
75 You can check :ref:`configuration` for details 75 You can check :ref:`configuration` for details
76 76
77 Usage 77 Usage
78 ===== 78 =====
79 79
80 To launch the sat backend, enter:: 80 To launch the Libervia backend, enter::
81 81
82 $ sat 82 $ libervia-backend
83 83
84 …or, if you want to launch it in foreground:: 84 …or, if you want to launch it in foreground::
85 85
86 $ sat fg 86 $ libervia-backend fg
87 87
88 You can stop it with:: 88 You can stop it with::
89 89
90 $ sat stop 90 $ libervia-backend stop
91 91
92 To know if backend is launched or not:: 92 To know if backend is launched or not::
93 93
94 $ sat status 94 $ libervia-backend status
95 95
96 **NOTE**: if ``misc/org.libervia.Libervia.service`` is installed correctly (which should 96 **NOTE**: if ``misc/org.libervia.Libervia.service`` is installed correctly (which should
97 be done by during the installation), the backend is automatically launched when a frontend 97 be done by during the installation), the backend is automatically launched when a frontend
98 needs it. 98 needs it.
99 99