Documentation #33
Documentation #33
Conversation
Pages for installation & configuration, Skeletons for some others.
| SPDX-License-Identifier: GPL-3.0-or-later | ||
| --> | ||
|
|
||
| # Installation Instructions |
There was a problem hiding this comment.
How about providing a dockerized / Kubernetes option? I'd be interested in working on that.
There was a problem hiding this comment.
@mogren: I would be very happy about a short documentation and a possible example of use. Thanks a lot for your help.
By the way, there are already two Dockerfiles for dnt7-go. One from @jonashoechst exists for CORE in the tutorial branch. Another one is in the dtn7-playground repository. Thus, there should already be some inspiration for the Docker part.
There was a problem hiding this comment.
First, thanks a lot for your work, @CryptoCopter!
I added some notes or suggestions which you can just automatically apply to this PR. Would you please take another look? Thanks!
|
|
||
| Public name of the node. Will be set as the default Endoint id for all CLAs, unless a different one has been speified. | ||
|
|
||
| According to the [standard](https://tools.ietf.org/html/draft-ietf-dtn-bpbis-31#section-4.2.5.1.1), your ID should be: |
There was a problem hiding this comment.
The Node ID must be an unique identifier, as specified in section 4.2.5.2. Thus, it cannot be the null endpoint or a multicast address.
| - `dtn://` + the actual name + `/` <- for a unicast enpoint | ||
| - `dtn://~` + the name of your multicast group + `/` <- for something that is not a unicast enpoint (it does not neccessarily have to be a multicast group, but that's the only use case I can think off the top of my head) | ||
|
|
||
| You might also use the [other](https://tools.ietf.org/html/draft-ietf-dtn-bpbis-31#section-4.2.5.1.2) adressing scheme, but we can't guarantee that such behaviour won't lead to death and/or dismemberment. |
There was a problem hiding this comment.
Even if I also dislike the ipn URI scheme, it should be properly implemented and should work as well. Thus, no need for such harsh words.
|
|
||
| ## Manual | ||
|
|
||
| - Install the *Go Programming language*, either through your package manager, or from [here](https://golang.org/dl/). |
There was a problem hiding this comment.
Perhaps add a note to always use the latest release or at least one greater than 1.13.
| - (Optional) Run `GO111MODULE=on go test ./...` in the repository root to make sur we didn't screw up too badly. | ||
| - Run `GO111MODULE=on go build ./...` in the repositry root to build both `dtnd` and `dtn-tool` | ||
|
|
||
| If you want to run `dtnd` as a service, you might also want to do the following: |
There was a problem hiding this comment.
The following section is very targeted to a specific setup; a generic GNU/Linux with systemd. Thus, this might be moved to the "Other Linux" section. You might wanna also add a reference from, e.g., Arch Linux to this section.
| Install it from the [AUR](https://aur.archlinux.org/packages/dtn7) either manually, or using your favourite aur-helper. | ||
|
|
||
| The package also installs the config file & systemd-service. | ||
| Also takes care of directory & user creation. |
There was a problem hiding this comment.
Might be nitpicking, but can you please replace & with and in the two previous lines.
Co-authored-by: Alvar <8402811+oxzi@users.noreply.github.com>
I guess it's time for us to start writing some actual documentation. As-is, if you don't already know how to use this software, it can be a bit obtuse.
Feel free to contribute.