lxc/incus
1
0
Fork 0
mirror of https://github.com/lxc/incus.git synced 2026-02-05 09:46:19 +01:00
Code Issues Releases Activity
Files
cda392f148939ba1753efefc8f7c7e8f36fd9ce8
incus/README.md

82 lines
4.5 KiB
Markdown
Raw Normal View History

doc: reuse content from the repo README in the doc index Pull the suitable content from the README.rst file into the documentation index file and the installation instructions. Also move the contributing file so it is readable in GitHub and pull the contents into the docs. Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
2021-11-26 17:34:48 +01:00
[![LXD](https://linuxcontainers.org/static/img/containers.png)](https://linuxcontainers.org/lxd)
# LXD
LXD is a next generation system container and virtual machine manager.
It offers a unified user experience around full Linux systems running inside containers or virtual machines.
It's image based with pre-made images available for a [wide number of Linux distributions](https://images.linuxcontainers.org)
and is built around a very powerful, yet pretty simple, REST API.
To get a better idea of what LXD is and what it does, you can [try it online](https://linuxcontainers.org/lxd/try-it/)!
Then if you want to run it locally, take a look at our [getting started guide](https://linuxcontainers.org/lxd/getting-started-cli/).
- Release announcements: <https://linuxcontainers.org/lxd/news/>
- Release tarballs: <https://linuxcontainers.org/lxd/downloads/>
- Documentation: <https://linuxcontainers.org/lxd/docs/master/>
doc: change file inclusion to use comments instead of text When including content from another file, we can select which content to include by specifying any start and end strings. Update the current includes to use HTML comments instead of plain text (which might change in the future). Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
2022-01-04 15:29:22 +01:00
<!-- Include end LXD intro -->
doc: reuse content from the repo README in the doc index Pull the suitable content from the README.rst file into the documentation index file and the installation instructions. Also move the contributing file so it is readable in GitHub and pull the contents into the docs. Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
2021-11-26 17:34:48 +01:00
## Status
Type | Service | Status
--- | --- | ---
CI (client) | GitHub | [![Build Status](https://github.com/lxc/lxd/workflows/Client%20build%20and%20unit%20tests/badge.svg)](https://github.com/lxc/lxd/actions)
CI (server) | Jenkins | [![Build Status](https://jenkins.linuxcontainers.org/job/lxd-github-commit/badge/icon)](https://jenkins.linuxcontainers.org/job/lxd-github-commit/)
Go documentation | Godoc | [![GoDoc](https://godoc.org/github.com/lxc/lxd/client?status.svg)](https://godoc.org/github.com/lxc/lxd/client)
Static analysis | GoReport | [![Go Report Card](https://goreportcard.com/badge/github.com/lxc/lxd)](https://goreportcard.com/report/github.com/lxc/lxd)
Translations | Weblate | [![Translation status](https://hosted.weblate.org/widgets/linux-containers/-/svg-badge.svg)](https://hosted.weblate.org/projects/linux-containers/lxd/)
Project status | CII Best Practices | [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1086/badge)](https://bestpractices.coreinfrastructure.org/projects/1086)
doc: change file inclusion to use comments instead of text When including content from another file, we can select which content to include by specifying any start and end strings. Update the current includes to use HTML comments instead of plain text (which might change in the future). Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
2022-01-04 15:29:22 +01:00
<!-- Include start installing -->
doc: reuse content from the repo README in the doc index Pull the suitable content from the README.rst file into the documentation index file and the installation instructions. Also move the contributing file so it is readable in GitHub and pull the contents into the docs. Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
2021-11-26 17:34:48 +01:00
## Installing LXD from packages
The LXD daemon only works on Linux but the client tool (`lxc`) is available on most platforms.
OS | Format | Command
--- | --- | ---
Linux | [Snap](https://snapcraft.io/lxd) | snap install lxd
Windows | [Chocolatey](https://chocolatey.org/packages/lxc) | choco install lxc
MacOS | [Homebrew](https://formulae.brew.sh/formula/lxc) | brew install lxc
More instructions on installing LXD for a wide variety of Linux distributions and operating systems [can be found on our website](https://linuxcontainers.org/lxd/getting-started-cli/).
doc: change file inclusion to use comments instead of text When including content from another file, we can select which content to include by specifying any start and end strings. Update the current includes to use HTML comments instead of plain text (which might change in the future). Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
2022-01-04 15:29:22 +01:00
<!-- Include end installing -->
doc: reuse content from the repo README in the doc index Pull the suitable content from the README.rst file into the documentation index file and the installation instructions. Also move the contributing file so it is readable in GitHub and pull the contents into the docs. Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
2021-11-26 17:34:48 +01:00
To install LXD from source, see [Installing LXD](doc/installing.md) in the documentation.
doc: change file inclusion to use comments instead of text When including content from another file, we can select which content to include by specifying any start and end strings. Update the current includes to use HTML comments instead of plain text (which might change in the future). Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
2022-01-04 15:29:22 +01:00
<!-- Include start security -->
doc: reuse content from the repo README in the doc index Pull the suitable content from the README.rst file into the documentation index file and the installation instructions. Also move the contributing file so it is readable in GitHub and pull the contents into the docs. Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
2021-11-26 17:34:48 +01:00
## Security
LXD, similar to other container and VM managers provides a UNIX socket for local communication.
**WARNING**: Anyone with access to that socket can fully control LXD, which includes
the ability to attach host devices and filesystems, this should
therefore only be given to users who would be trusted with root access
to the host.
When listening on the network, the same API is available on a TLS socket
(HTTPS), specific access on the remote API can be restricted through
Canonical RBAC.
doc: change file inclusion to use comments instead of text When including content from another file, we can select which content to include by specifying any start and end strings. Update the current includes to use HTML comments instead of plain text (which might change in the future). Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
2022-01-04 15:29:22 +01:00
<!-- Include end security -->
doc: reuse content from the repo README in the doc index Pull the suitable content from the README.rst file into the documentation index file and the installation instructions. Also move the contributing file so it is readable in GitHub and pull the contents into the docs. Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
2021-11-26 17:34:48 +01:00
More details are [available here](doc/security.md).
doc: change file inclusion to use comments instead of text When including content from another file, we can select which content to include by specifying any start and end strings. Update the current includes to use HTML comments instead of plain text (which might change in the future). Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
2022-01-04 15:29:22 +01:00
<!-- Include start support -->
doc: reuse content from the repo README in the doc index Pull the suitable content from the README.rst file into the documentation index file and the installation instructions. Also move the contributing file so it is readable in GitHub and pull the contents into the docs. Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
2021-11-26 17:34:48 +01:00
## Support and community
The following channels are available for you to interact with the LXD community.
### Bug reports
You can file bug reports and feature requests at: <https://github.com/lxc/lxd/issues/new>
### Forum
A discussion forum is available at: <https://discuss.linuxcontainers.org>
### Mailing-lists
We use the LXC mailing lists for developer and user discussions. You can
find and subscribe to those at: <https://lists.linuxcontainers.org>
### IRC
If you prefer live discussions, you can find us in [#lxc](https://kiwiirc.com/client/irc.libera.chat/#lxc) on irc.libera.chat. See [Getting started with IRC](https://discuss.linuxcontainers.org/t/getting-started-with-irc/11920) if needed.
## Contributing
doc: change file inclusion to use comments instead of text When including content from another file, we can select which content to include by specifying any start and end strings. Update the current includes to use HTML comments instead of plain text (which might change in the future). Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
2022-01-04 15:29:22 +01:00
Fixes and new features are greatly appreciated. <!-- Include end support --> Make sure to read our [contributing guidelines](CONTRIBUTING.md) first!
Copy Permalink