README
¶
Uqda Core
About
Uqda Core provides an implementation of a fully end-to-end encrypted IPv6 network. See https://github.com/Uqda/Core for documentation and updates.
Installation
See the releases page for pre-built binaries.
Maintainers — automatic releases: pushing a semver tag matching v1.2.3 runs .github/workflows/release.yml, which builds Linux/Windows/macOS artifacts and publishes one bundle per platform (each bundle contains both uqda and uqdactl) plus SHA256SUMS on the GitHub Release. Example: git tag -a v0.1.0 -m "Uqda Core 0.1.0" && git push origin v0.1.0.
Installers on the same release page: .github/workflows/pkg.yml now also runs on v* tags and uploads .deb / .pkg / .msi (plus router packages and vendored sources) to the same GitHub Release, so users can install via one platform package without extra manual assembly.
Documentation
Start here: Documentation hub — full project map (architecture, packages, features, links to every guide).
Concepts and operation
- About Uqda
- Network capabilities & full config guide — what the mesh provides; every
uqda.conffield; URI options;uqda/uqdactlsurfaces - Hosting a website on Uqda
- Unified DNS for your mesh
- Configuration
- Configuration reference
- Advanced peerings
- FAQ
- Private network: two people only
- Uninstall completely
- Key rotation after a leak
- Testing and release checks
Installation guides
- Ubiquiti EdgeOS / vyatta-uqda
- Windows
- macOS (manual build)
- macOS (.pkg installer)
- Linux (manual build)
- OpenWrt
- Gentoo
- Debian / Ubuntu / Mint
- RPM (Fedora / RHEL / CentOS)
- FreeBSD
Building from source
./build
This produces uqda and uqdactl in the repository root.
Configuration
Generate a new configuration:
./uqda -genconf > /path/to/uqda.conf
Run with a configuration file:
./uqda -useconffile /path/to/uqda.conf
Further options are documented in the repository and generated configuration comments.
License
This repository’s LICENSE file is GNU LGPLv3 (with the library linking exception in that file). The project source and layout follow that license; see LICENSE for the full text.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
genkeys
command
This file generates crypto keys.
|
This file generates crypto keys. |
|
uqda
command
|
|
|
uqdactl
command
|
|
|
contrib
|
|
|
ansible
command
This file generates host_vars and vault key material for use with Ansible and Uqda.
|
This file generates host_vars and vault key material for use with Ansible and Uqda. |
|
src
|
|
|
address
Package address contains the types used by Uqda to represent IPv6 addresses or prefixes, as well as functions for working with these types.
|
Package address contains the types used by Uqda to represent IPv6 addresses or prefixes, as well as functions for working with these types. |
|
config
The config package contains structures related to the configuration of an Uqda node.
|
The config package contains structures related to the configuration of an Uqda node. |