Git-Mirrors/NomadNet
1
0
Fork 0
mirror of https://github.com/markqvist/NomadNet.git synced 2025-02-26 18:01:15 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated readme and dockerfile

Browse Source
This commit is contained in:
Mark Qvist 2022-05-17 13:18:55 +02:00
parent 467f02b379
commit 73fb44dcc3
2 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Dockerfile
View File

@ -13,7 +13,7 @@ RUN cd /app/ && python3 setup.py install
# Use multi-stage build, as we don't need rust compilation on the final image
FROM python:3.11-rc-alpine3.14
LABEL org.opencontainers.image.documentation="https://github.com/jphastings/NomadNet#using-docker--running-a-daemon"
LABEL org.opencontainers.image.documentation="https://github.com/markqvist/NomadNet#using-docker--running-a-daemon"
ENV PATH="/opt/venv/bin:$PATH"
COPY --from=build /opt/venv /opt/venv
@ -21,4 +21,4 @@ COPY --from=build /opt/venv /opt/venv
VOLUME /root/.reticulum
VOLUME /root/.nomadnetwork
ENTRYPOINT ["nomadnet"]
ENTRYPOINT ["nomadnet --daemon"]

10
README.md
View File

@ -38,6 +38,12 @@ pip3 install nomadnet
# Run the client
nomadnet
# Or alternatively run as a daemon, with no user interface
nomadnet --daemon
# List options
nomadnet --help
```
The first time the program is running, you will be presented with the guide section, which contains all the information you need to start using Nomad Network.
@ -48,12 +54,12 @@ If you want to try Nomad Network without building your own physical network, you
**Please Note**: If this is the very first time you use pip to install a program on your system, you might need to reboot your system for the program to become available. If you get a "command not found" error or similar when running the program, reboot your system and try again.
### Installing on Android
### Install on Android
You can install Nomad Network on Android using Termux, but there's a few more commands involved than the above one-liner. The process is documented in the [Android Installation](https://markqvist.github.io/Reticulum/manual/gettingstartedfast.html#reticulum-on-android) section of the Reticulum Manual. Once the Reticulum has been installed according to the linked documentation, Nomad Network can be installed as usual with pip.
For a native Android application with a graphical user interface, have a look at [Sideband](https://unsigned.io/sideband).
### Using docker / running a daemon
### Nomad Network Daemon in Docker
Nomad Network is automatically published as a docker image on Github Packages. Image tags are one of either `master` (for the latest release) or the version number (eg `0.1.7`) for the specified version number (as tagged in this git repo).