external
/
uhub
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update getstarted.txt

This commit is contained in:
Kcchouette 2018-10-15 11:22:18 +02:00 committed by Jan Vidar Krey
parent 62216a7afe
commit 7970f80114
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/getstarted.txt
View File

@ -1,8 +1,6 @@
Getting started guide Getting started guide
--------------------- ---------------------
(This document is maintained at http://www.extatic.org/uhub/getstarted.html )
Unpack your binaries Unpack your binaries
Example: Example:
@ -17,6 +15,7 @@ Create configuration files.
If no configuration files are created, uhub will use the default parameters, so you can skip this step if you are in a hurry to see it run. If no configuration files are created, uhub will use the default parameters, so you can skip this step if you are in a hurry to see it run.
As root, or use sudo. As root, or use sudo.
% mkdir /etc/uhub % mkdir /etc/uhub
% cp doc/uhub.conf /etc/uhub % cp doc/uhub.conf /etc/uhub
% cp doc/users.conf /etc/uhub % cp doc/users.conf /etc/uhub
@ -32,8 +31,11 @@ NOTE: It is important to use the "adc://" prefix, and the port number when using
If you modify the configuration files in /etc/uhub you will have to notify uhub by sending a HUP signal. If you modify the configuration files in /etc/uhub you will have to notify uhub by sending a HUP signal.
% ps aux | grep uhub
% kill -HUP <pid of uhub> % kill -HUP <pid of uhub>
Or, for the lazy people Or, for the lazy people
% killall -HUP uhub % killall -HUP uhub
In order to run uhub as a daemon, start it with the -f switch which will make it fork into the background. In order to run uhub as a daemon, start it with the -f switch which will make it fork into the background.
@ -41,8 +43,8 @@ In addition, use the -l to specify a log file instead of stdout. One can also sp
if one wishes to run uhub as a specific user using the -u and -g switches. if one wishes to run uhub as a specific user using the -u and -g switches.
Example: Example:
% uhub -f -l mylog.txt -u nobody -g nogroup
% uhub -f -l mylog.txt -u nobody -g nogroup
If you are planning to more than 1024 users on hub, you must increase the max number of file descriptors allowed. If you are planning to more than 1024 users on hub, you must increase the max number of file descriptors allowed.
This limit needs to be higher than the configured max_users in uhub.conf. This limit needs to be higher than the configured max_users in uhub.conf.
@ -52,6 +54,14 @@ In linux can add the following lines to /etc/security/limits.conf (allows for ~4
* hard nofile 4096 * hard nofile 4096
Or, you can use (as root): Or, you can use (as root):
% ulimit -n 4096 % ulimit -n 4096
You can interact with uhub in your hub main chat using the `!` prefix, followed by a command:
Example :
* to display help and the command you can use:
!help
Your mileage may vary -- Good luck! Your mileage may vary -- Good luck!