Skip to content

Commit

Permalink
Move documentation to doc subdirectory
Browse files Browse the repository at this point in the history
  • Loading branch information
mbuesch committed Jan 5, 2025
1 parent 4d68992 commit 2123541
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 9 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@ There are descriptions about how to do that on the Internet.
It's not as hard and as much work as it sounds. :)

The letmein control communication itself defaults to TCP port 5800, but it can be configured to any TCP or UDP port.
If you choose a UDP port as control port and configure [control-error-policy=basic-auth](CONFIGURATION.md#control-error-policy), then the letmein service itself operates in stealth mode and doesn't respond to unauthenticated incoming messages.
If you choose a UDP port as control port and configure [control-error-policy=basic-auth](doc/CONFIGURATION.md#control-error-policy), then the letmein service itself operates in stealth mode and doesn't respond to unauthenticated incoming messages.

## Typical letmein operation flow

![image](pic/letmein_overview.png)
![image](doc/pic/letmein_overview.png)

A detailed description of the wire protocol and the cryptography used can be found in the [protocol documentation](PROTOCOL.md)
A detailed description of the wire protocol and the cryptography used can be found in the [protocol documentation](doc/PROTOCOL.md)

## Project links

Expand Down Expand Up @@ -110,11 +110,11 @@ Match host your-server.com exec "letmein knock -u 00000000 your-server.com 22"

## Installing

See the [installation instructions](INSTALL.md) for more information about how to build and install letmein.
See the [installation instructions](doc/INSTALL.md) for more information about how to build and install letmein.

## Uninstalling

If you want to completely remove letmein from your system, see the [uninstall instructions](INSTALL.md#uninstalling).
If you want to completely remove letmein from your system, see the [uninstall instructions](doc/INSTALL.md#uninstalling).

## Platform support

Expand All @@ -134,7 +134,7 @@ The server application `letmeind` is Linux-only, because it only supports `nftab

## Configuration

See the [configuration documentation](CONFIGURATION.md) for detailled information about how to configure the letmein server and client.
See the [configuration documentation](doc/CONFIGURATION.md) for detailled information about how to configure the letmein server and client.

## Security notice: User identifiers and resource identifiers

Expand All @@ -144,7 +144,7 @@ Make sure the user identifiers and resource identifiers do **not** include any p

These identifiers are merely meant to be an abstract identification for managing different `letmein` keys, installations and setups.

See the documentation about [keys](CONFIGURATION.md#keys) and [resources](CONFIGURATION.md#resources) for detailled information.
See the documentation about [keys](doc/CONFIGURATION.md#keys) and [resources](doc/CONFIGURATION.md#resources) for detailled information.

## Internals and design goals

Expand Down
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions PROTOCOL.md → doc/PROTOCOL.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ and use the result as the `AUTH` field of this `KNOCK` message.

The server must
[validate the received AUTH token](PROTOCOL.md#validate-auth-token)
of this `KNOCK` message before continuing in the communication flow.
of this `KNOCK` message before continuing with the communication flow.
It is valid but not mandatory to send a `GOAWAY` message from server to client, if the validation failed.
The communication must not continue beyond that, if validation failed.

Expand Down Expand Up @@ -141,7 +141,7 @@ and use the result as the `AUTH` field of this `RESPONSE` message.

The server must
[validate the received AUTH token](PROTOCOL.md#validate-auth-token)
of this `RESPONSE` message before continuing in the communication flow.
of this `RESPONSE` message before continuing with the communication flow.
It is valid but not mandatory to send a `GOAWAY` message from server to client, if the validation failed.
The communication must not continue beyond that, if validation failed.

Expand Down
File renamed without changes
File renamed without changes

0 comments on commit 2123541

Please sign in to comment.