2023-09-07 21:10:46 -04:00
|
|
|
# Installation
|
|
|
|
|
|
|
|
|
|
There are multiple methods of installing Telodendria. Choose the one
|
|
|
|
|
best suited to your use case.
|
|
|
|
|
|
|
|
|
|
## Package Manager Or System Ports
|
|
|
|
|
|
|
|
|
|
This is the recommended way to install Telodendria. If your operating
|
|
|
|
|
system has an official package or port of Telodendria, you should
|
|
|
|
|
prefer to use that instead of the other methods documented here,
|
|
|
|
|
because your operating system or software distribution will have
|
|
|
|
|
already figured out how to best integrate Telodendria with your system.
|
|
|
|
|
|
|
|
|
|
Consult your operating system or software distribution's system
|
|
|
|
|
manual for instructions on how to install packages. Also consult the
|
|
|
|
|
official repository of your distribution to see if a package is
|
|
|
|
|
available. If a package exists but it is too out of date for your
|
|
|
|
|
tastes, please contact the package's maintainer to notify them, or
|
|
|
|
|
offer to update the package yourself using the
|
|
|
|
|
[porting instructions](../dev/ports.md).
|
|
|
|
|
|
|
|
|
|
If you are maintaining a port or package for an operating system or
|
|
|
|
|
software distribution, open a pull request to include your
|
|
|
|
|
platform-specific instructions as a subheader of this section.
|
|
|
|
|
Eventually, this section should contain basic instructions for the
|
|
|
|
|
operating systems that have packages or ports.
|
|
|
|
|
See [Ports](../dev/ports.md) for the project's distribution
|
|
|
|
|
philosophy.
|
|
|
|
|
|
|
|
|
|
## Container
|
|
|
|
|
|
|
|
|
|
At this time, Telodendria does not have any officially recommended
|
|
|
|
|
procedure for running in a container such as Docker or Vagrant. You
|
|
|
|
|
may find helpful files in the [`contrib/`](../../contrib) directory,
|
|
|
|
|
however.
|
|
|
|
|
|
|
|
|
|
If you are publishing container images, please open a pull request to
|
|
|
|
|
add your source files to `contrib/`, as well as to add documentation
|
|
|
|
|
under this section explaining how to get set started.
|
|
|
|
|
|
|
|
|
|
## Release Binary
|
|
|
|
|
|
|
|
|
|
At this time, Telodendria does not publish any official binaries that
|
|
|
|
|
can be downloaded. The tentative plan is to eventually provide binaries
|
|
|
|
|
with each release for a number of supported platforms. When that
|
|
|
|
|
happens, instructions will be provided here for dealing with the
|
|
|
|
|
binaries.
|
|
|
|
|
|
|
|
|
|
## From Source
|
|
|
|
|
|
2023-09-09 16:50:38 -04:00
|
|
|
If you would like to build Telodendria from source, you can download
|
|
|
|
|
the latest release code from the
|
|
|
|
|
[Releases](/Telodendria/telodendria/releases) page. After extracting
|
|
|
|
|
the tarball, read
|
Use `Makefile`s instead of a custom script (#38)
This pull request also requires the use of the external [Cytoplasm](/Telodendria/Cytoplasm) repository by removing the in-tree copy of Cytoplasm. The increased modularity requires a little more complex build process, but is overall better. Closes #19
The appropriate documentation has been updated. Closes #18
---
Please review the developer certificate of origin:
1. The contribution was created in whole or in part by me, and I have
the right to submit it under the open source licenses of the
Telodendria project; or
1. The contribution is based upon a previous work that, to the best of
my knowledge, is covered under an appropriate open source license and
I have the right under that license to submit that work with
modifications, whether created in whole or in part by me, under the
Telodendria project license; or
1. The contribution was provided directly to me by some other person
who certified (1), (2), or (3), and I have not modified it.
1. I understand and agree that this project and the contribution are
made public and that a record of the contribution—including all
personal information I submit with it—is maintained indefinitely
and may be redistributed consistent with this project or the open
source licenses involved.
- [x] I have read the Telodendria Project development certificate of
origin, and I certify that I have permission to submit this patch
under the conditions specified in it.
Reviewed-on: https://git.telodendria.io/Telodendria/Telodendria/pulls/38
2023-11-01 12:27:45 -04:00
|
|
|
[Contributing → Developing → Building & Running](../CONTRIBUTING.md#building-amp-running)
|
2023-09-09 16:50:38 -04:00
|
|
|
for details on how to build Telodendria.
|