Skip to content
This repository has been archived by the owner on Apr 5, 2024. It is now read-only.

Documentation #33

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

Documentation #33

wants to merge 4 commits into from

Conversation

CryptoCopter
Copy link
Member

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.

Pages for installation & configuration, Skeletons for some others.
@CryptoCopter CryptoCopter added the help wanted Extra attention is needed label Feb 5, 2021
Copy link
Contributor

@mogren mogren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A great start, having some scaffolding makes it easier for contributors to edit and add to it.

SPDX-License-Identifier: GPL-3.0-or-later
-->

# Installation Instructions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about providing a dockerized / Kubernetes option? I'd be interested in working on that.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.

docs/install.md Outdated Show resolved Hide resolved
Copy link
Member

@oxzi oxzi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

docs/config.md Outdated Show resolved Hide resolved

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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

docs/config.md Outdated Show resolved Hide resolved

## Manual

- Install the *Go Programming language*, either through your package manager, or from [here](https://golang.org/dl/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

docs/install.md Outdated Show resolved Hide resolved
docs/install.md Outdated Show resolved Hide resolved
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be nitpicking, but can you please replace & with and in the two previous lines.

docs/install.md Outdated Show resolved Hide resolved
docs/config.md Outdated Show resolved Hide resolved
docs/config.md Outdated Show resolved Hide resolved
docs/config.md Outdated Show resolved Hide resolved
docs/install.md Outdated Show resolved Hide resolved
docs/install.md Outdated Show resolved Hide resolved
docs/install.md Outdated Show resolved Hide resolved
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants