uhub/README
2019-05-15 11:10:54 +02:00

48 lines
1.6 KiB
Plaintext

# Uhub
Uhub is a high performance peer-to-peer hub for the ADC network. Its low memory footprint allows it to handle several thousand users on high-end servers, or a small private hub on embedded hardware.
Uhub uses the ADC protocol, and is compatible with DC++, jUCy and other ADC clients.
## Key features
- High performance and low memory usage
- IPv4 and IPv6 support
- Experimental SSL support (optional)
- Advanced access control support
- Easy configuration
## Download
You can also use git to use the last up-to-date version:
$ git clone https://github.com/janvidar/uhub.git
You can also find zip / tar.gz files of different uhub versions on https://github.com/janvidar/uhub/releases
### Ubuntu and Debian packages
Tehnick has provided an up to date uhub PPA for Debian and Ubuntu based distributions: https://tehnick.github.io/uhub/
## Documentation
### Compile
See doc/compile.txt document or https://github.com/janvidar/uhub/blob/master/doc/compile.txt.
### Getting started
See doc/getstarted.txt document or https://github.com/janvidar/uhub/blob/master/doc/getstarted.txt.
### Use SSL
See doc/ssl-documentation.txt document or https://github.com/janvidar/uhub/blob/master/doc/ssl-documentation.txt.
## Compatible clients
For a list of compatible ADC clients, see:
https://en.wikipedia.org/wiki/Comparison_of_ADC_software#Client_software
## License
Uhub is free and open source software, licensed under the GNU General Public License 3.
See COPYING file, https://github.com/janvidar/uhub/blob/master/COPYING or directly https://www.gnu.org/licenses/gpl-3.0.txt