You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<li><ahref="#things-to-consider-for-systemd">Things to consider for systemd</a></li>
62
+
<li><ahref="#systemd-service-file">systemd service file</a></li>
63
+
<li><ahref="#notice-for-systemd-installation">Notice for systemd installation</a></li>
62
64
</ul></li>
63
65
</ul>
64
66
<!-- vim-markdown-toc -->
@@ -118,6 +120,14 @@ <h3 id="how-it-works">How it works</h3>
118
120
<h2id="installation">Installation <spanstyle="padding-left: 10px;"><supstyle="font-size: 50%"><ahref="#" title="Go to top of the page">Top</a></sup></span></h2>
119
121
<p>By the term “installation”, we mean that we set up things in such a way, that after we log into the system, we find <strong>PyRadio</strong> ready to accept connections.</p>
120
122
<p>So, the installation can be as easy as adding a line in a configuration file (or the startup section of the <em>desktop environment</em>) or as hard as adding a system service.</p>
123
+
<h3id="notice">Notice</h3>
124
+
<p>The commands that follow use the following conventions:</p>
125
+
<oltype="1">
126
+
<li><p>The username is <strong>spiros</strong>.<br/>
127
+
Please replace it with your username.</p></li>
128
+
<li><p><strong>PyRadio</strong> is installed from source; this means that its executable is <strong>~/.local/bin/pyradio</strong>. If this is not the case (using a distribution package, for example), please replace it with the correct one.</p></li>
129
+
<li><p>Both <strong>tmux</strong> and <strong>screen</strong> are executed using their <em>absolute path</em> (<strong>/usr/bin/tmux</strong> and <strong>/usr/bin/screen</strong> respectively). If they are installed at a different location, please use the correct one instead.</p></li>
130
+
</ol>
121
131
<h3id="using-tmux">Using tmux</h3>
122
132
<p>If <strong>bash</strong> is the default shell, this would do the trick:</p>
<pstyle="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> You will want to replace the word “<em>spiros</em>” with your <strong>username</strong> in this file.</p>
<p>In case a <em>Window manager</em> is used, adding a line in its <strong>autostart</strong> file would be enough. For example, this would work for <strong>openbox</strong>:</p>
<pstyle="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> You will want to replace the word “<em>spiros</em>” with your <strong>username</strong> in this file.</p>
$ sudo systemctl enable pyradio # enabling the autostart on every boot</pre>
211
-
<h3id="things-to-consider-for-systemd">Things to consider for systemd</h3>
212
-
<oltype="1">
213
-
<li><p>You will want to replace the word “<em>spiros</em>” with your <strong>username</strong> in the <em>/lib/systemd/system/pyradio.service</em> file.</p></li>
214
-
<li><p>The service file has two lines starting with “<em>Environment=</em>”<br/>
215
-
<br/>
216
-
These two lines provide an environment for <em>systemd</em>; I’ve found out that on Arch Linux, for example, <strong>PyRadio</strong> would produce no sound at all without them (actually not connection to the sound server).<br/>
217
-
<br/>
218
-
On other systems, on Raspberry Pi for example, they can be omitted altogether.</p></li>
sudo systemctl enable pyradio # enabling the autostart on every boot</pre>
202
+
<h3id="notice-for-systemd-installation">Notice for systemd installation</h3>
203
+
<p>The service file has two lines starting with “<em>Environment=</em>”</p>
204
+
<p>These two lines provide an environment for <em>systemd</em>; I’ve found out that on Arch Linux, for example, <strong>PyRadio</strong> would produce no sound at all without them (it would not be able to connect to the sound server).</p>
205
+
<p>On other systems, on Raspberry Pi for example, they can be omitted altogether.</p>
Copy file name to clipboardExpand all lines: docs/headless.md
+60-64Lines changed: 60 additions & 64 deletions
Original file line number
Diff line number
Diff line change
@@ -7,11 +7,13 @@
7
7
*[Usage](#usage)
8
8
*[How it works](#how-it-works)
9
9
*[Installation](#installation)
10
+
*[Notice](#notice)
10
11
*[Using tmux](#using-tmux)
11
12
*[systemd](#systemd)
12
13
*[Using screen](#using-screen)
13
14
*[systemd](#systemd)
14
-
*[Things to consider for systemd](#things-to-consider-for-systemd)
15
+
*[systemd service file](#systemd-service-file)
16
+
*[Notice for systemd installation](#notice-for-systemd-installation)
15
17
16
18
<!-- vim-markdown-toc -->
17
19
@@ -108,6 +110,17 @@ By the term "installation", we mean that we set up things in such a way, that af
108
110
109
111
So, the installation can be as easy as adding a line in a configuration file (or the startup section of the *desktop environment*) or as hard as adding a system service.
110
112
113
+
### Notice
114
+
115
+
The commands that follow use the following conventions:
116
+
117
+
1. The username is **spiros**. \
118
+
Please replace it with your username.
119
+
120
+
2.**PyRadio** is installed from source; this means that its executable is **~/.local/bin/pyradio**. If this is not the case (using a distribution package, for example), please replace it with the correct one.
121
+
122
+
3. Both **tmux** and **screen** are executed using their *absolute path* (**/usr/bin/tmux** and **/usr/bin/screen** respectively). If they are installed at a different location, please use the correct one instead.
123
+
111
124
### Using tmux
112
125
113
126
If **bash** is the default shell, this would do the trick:
@@ -131,66 +144,43 @@ The first thing you do is create the log file:
sudo systemctl enable pyradio # enabling the autostart on every boot
249
247
```
250
248
251
-
### Things to consider for systemd
249
+
### Notice for systemd installation
250
+
251
+
The service file has two lines starting with "*Environment=*"
252
252
253
-
1. You will want to replace the word "*spiros*" with your **username**in the */lib/systemd/system/pyradio.service* file.
253
+
These two lines provide an environment for *systemd*; I've found out that on Arch Linux, for example, **PyRadio**would produce no sound at all without them (it would not be able to connect to the sound server).
254
254
255
-
2. The service file has two lines starting with "*Environment=*" \
256
-
\
257
-
These two lines provide an environment for *systemd*; I've found out that on Arch Linux, for example, **PyRadio** would produce no sound at all without them (actually not connection to the sound server). \
258
-
\
259
255
On other systems, on Raspberry Pi for example, they can be omitted altogether.
0 commit comments