envs
/
help
mirror of https://git.envs.net/envs/help.git
1
0
Fork 0
Code Releases Activity

cleanup & "style" our help page

This commit is contained in:
creme 2021-08-07 23:59:43 +02:00
parent 6676afbef1
commit 7c527c422d
Signed by: creme
GPG Key ID: C147C3B7FBDF08D0
5 changed files with 99 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/blog.md
View File

@ -1,4 +1,5 @@
# # user blog # # user blog
you're blog is available under *https://envs.net/~username/blog* and *https://username.envs.net/blog*.<br /> you're blog is available under *https://envs.net/~username/blog* and *https://username.envs.net/blog*.<br />
and you can also use any other blogging software. ;) and you can also use any other blogging software. ;)

2
docs/gemini.md
View File

@ -13,7 +13,7 @@ we're trying to keep this cool corner of the web alive.
# # user gemini # # user gemini
main gemini page: `gemini://envs.net`<br /> main gemini page: `gemini://envs.net`
envs.net serves user gemini sites from your `~/public_gemini` directory. envs.net serves user gemini sites from your `~/public_gemini` directory.

146
docs/help.md
View File

@ -1,7 +1,7 @@
# basic help # basic help
> *write in irc/matrix channel `#envs`*<br /> > *write in irc channel `#envs` or on matrix [`#envs:envs.net`](https://matrix.to/#/#envs:envs.net)*
> *for any other help requests.* > *for any help requests and community support.*
## # show public ip ## # show public ip
`curl ip.envs.net` `curl ip.envs.net`
@ -14,19 +14,20 @@ add the following lines to you're aliases file `~/.bash_aliases`
0url() { curl -F"url=$1" https://envs.sh ; } 0url() { curl -F"url=$1" https://envs.sh ; }
0short() { curl -F"shorten=$1" https://envs.sh ; } 0short() { curl -F"shorten=$1" https://envs.sh ; }
``` ```
HTTP POST files here:<br /> HTTP POST files here:
&nbsp;&nbsp;`0file "yourfile.png"` &nbsp;&nbsp;`0file "yourfile.png"`
post your text directly:<br /> post your text directly:
&nbsp;&nbsp;`echo "text here" | 0pb` &nbsp;&nbsp;`echo "text here" | 0pb`
you can also POST remote URLs:<br /> you can also POST remote URLs:
&nbsp;&nbsp;`0url "https://example.com/image.jpg"` &nbsp;&nbsp;`0url "https://example.com/image.jpg"`
or you can shorten URLs:<br /> or you can shorten URLs:
&nbsp;&nbsp;`0short "https://example.com/some/long/url"`<br /> &nbsp;&nbsp;`0short "https://example.com/some/long/url"`
<br />
***if you want a nice wrapper, try [~tomasino's pb](https://git.envs.net/envs/pb)*** !!! tip
if you want a nice wrapper, try [~tomasino's pb](https://git.envs.net/envs/pb)
## # ssh ## # ssh
your ssh directory is: `~/.ssh/` this includes the following files. your ssh directory is: `~/.ssh/` this includes the following files.
@ -35,44 +36,47 @@ your ssh directory is: `~/.ssh/` this includes the following files.
- the `authorized_keys`-file is a list of public keys (one per line) that are allowed to log in to your user account. - the `authorized_keys`-file is a list of public keys (one per line) that are allowed to log in to your user account.
- `id_ed25519` or `id_rsa` are each private keys, and `id_ed25519.pub` or `id_rsa.pub` are the corresponding pubkey. - `id_ed25519` or `id_rsa` are each private keys, and `id_ed25519.pub` or `id_rsa.pub` are the corresponding pubkey.
envs.net ED25519 key fingerprint is `SHA256:V+mXTsRJ+jfJMxxPlD/28dpWouuns3Wuqwppv6ykVC8` and for<br /> envs.net ED25519 key fingerprint is `SHA256:V+mXTsRJ+jfJMxxPlD/28dpWouuns3Wuqwppv6ykVC8` and for
RSA `SHA256:7dB470mfzlyhhtqmjnXciIxp+jWLACiYKC3EE/Z0lFg`. RSA `SHA256:7dB470mfzlyhhtqmjnXciIxp+jWLACiYKC3EE/Z0lFg`.
the key fingerprints are in dns as sshfp records as well, which you can check against<br> the key fingerprints are in dns as sshfp records as well, which you can check against
by setting VerifyHostKeyDNS to yes in your `~/.ssh/config`. by setting VerifyHostKeyDNS to yes in your `~/.ssh/config`.
you can check the records yourself with the `dig` tool like this:<br/> you can check the records yourself with the `dig` tool like this:
&nbsp;&nbsp;`dig sshfp envs.net` &nbsp;&nbsp;`dig sshfp envs.net`
### ssh details and usage ### ssh details and usage
ports 22, 80, 443, 2222 and 2223 are available for ssh.<br /> ports 22, 80, 443, 2222 and 2223 are available for ssh
use ssh.envs.net to reach the secondary ip and use 80 and 443 for ssh.<br /> use ssh.envs.net to reach the secondary ip and use 80 and 443 for ssh.
so, for example, you can do:<br /> so, for example, you can do:
&nbsp;&nbsp;`ssh user@envs.net`<br /> &nbsp;&nbsp;`ssh user@envs.net`
&nbsp;&nbsp;`ssh -p2223 user@envs.net` &nbsp;&nbsp;`ssh -p2223 user@envs.net`
or for the secondary ip:<br /> or for the secondary ip:
&nbsp;&nbsp;`ssh -p443 user@ssh.envs.net`<br /> &nbsp;&nbsp;`ssh -p443 user@ssh.envs.net`
<br />
***if you have a slightly shaky connection then you can also use `mosh`.***
--- !!! tip
if you have a slightly shaky connection then you can also use `mosh`.
&gt; [ssh windows usage](inc/ssh-windows.md)<br /> ***
&gt; [ssh windows usage](inc/ssh-windows.md)
&gt; [ssh mac usage](inc/ssh-mac.md) &gt; [ssh mac usage](inc/ssh-mac.md)
***
### create a ssh-key ### create a ssh-key
make sure you have a `~/.ssh directory`<br /> make sure you have a `~/.ssh directory`
&nbsp;&nbsp;`mkdir -m 700 ~/.ssh` &nbsp;&nbsp;`mkdir -m 700 ~/.ssh`
create your key<br /> create your key
&nbsp;&nbsp;`ssh-keygen -t ed25519 -a 100` &nbsp;&nbsp;`ssh-keygen -t ed25519 -a 100`
your public and private key will be located at<br /> your public and private key will be located at
&nbsp;&nbsp;`cat ~/.ssh/id_ed25519.pub` &nbsp;&nbsp;`cat ~/.ssh/id_ed25519.pub`
you can also use rsa:<br /> you can also use rsa:
&nbsp;&nbsp;`ssh-keygen -t rsa -b 4096`<br /> &nbsp;&nbsp;`ssh-keygen -t rsa -b 4096`
&nbsp;&nbsp;`cat ~/.ssh/id_rsa.pub` &nbsp;&nbsp;`cat ~/.ssh/id_rsa.pub`
### ssh config ### ssh config
@ -85,21 +89,21 @@ Host envs.net
LocalForward localhost:6667 localhost:6667 LocalForward localhost:6667 localhost:6667
``` ```
now you can use a simple `ssh envs.net` to connect.<br /> now you can use a simple `ssh envs.net` to connect.
there are tons of other options, including this `LocalForward` line to automatically set up the tunnel as show below.<br /> there are tons of other options, including this `LocalForward` line to automatically set up the tunnel as show below.
for more available options, see the man page: `man ssh_config` for more available options, see the man page: `man ssh_config`
### ssh tunnels ### ssh tunnels
for example, you want to get into znc with your local client (weechat, etc),<br /> for example, you want to get into znc with your local client (weechat, etc),
but your local network blocks znc ports. you can connect to envs.net, and use port forwarding to get on. but your local network blocks znc ports. you can connect to envs.net, and use port forwarding to get on.
if you are connecting from a linux machine, you can do this:<br /> if you are connecting from a linux machine, you can do this:
&nbsp;&nbsp;`ssh -L 6667:localhost:6667 envs.net` &nbsp;&nbsp;`ssh -L 6667:localhost:6667 envs.net`
after being logged in, open your local irc client, and use `127.0.0.1:6667`<br /> after being logged in, open your local irc client, and use `127.0.0.1:6667`
for your server setting. voila! you're now on envs.net znc server.<br /> for your server setting. voila! you're now on envs.net znc server.
what that ssh command did was open a local port tunnel (-L), using local port 6667 (6667:)<br /> what that ssh command did was open a local port tunnel (-L), using local port 6667 (6667:)
pointed at localhost (from the remote's point of view), on remote port 6667 (default irc port). pointed at localhost (from the remote's point of view), on remote port 6667 (default irc port).
putty has the same ability (for windows and mac users), under connection &gt; ssh &gt; tunnels. putty has the same ability (for windows and mac users), under connection &gt; ssh &gt; tunnels.
@ -107,94 +111,94 @@ putty has the same ability (for windows and mac users), under connection &gt; ss
you can do this for any arbitrary port. you can do this for any arbitrary port.
### import &amp; authorize a public ssh-key ### import &amp; authorize a public ssh-key
from URL (on remote machine)<br /> from URL (on remote machine)
&nbsp;&nbsp;`echo $(curl -sL https://example.com/id_rsa.pub) | tee -a ~/.ssh/authorized_keys` &nbsp;&nbsp;`echo $(curl -sL https://example.com/id_rsa.pub) | tee -a ~/.ssh/authorized_keys`
over ssh (on local machine)<br /> over ssh (on local machine)
&nbsp;&nbsp;`ssh-copy-id -i ~/.ssh/id_rsa.pub -p2223 user@envs.net;` &nbsp;&nbsp;`ssh-copy-id -i ~/.ssh/id_rsa.pub -p2223 user@envs.net;`
### ssh remote execution ### ssh remote execution
`ssh envs.net ping google.de` `ssh envs.net ping google.de`
or<br /> or
&nbsp;&nbsp;`ssh envs.net bash -c "'uname -a'"` &nbsp;&nbsp;`ssh envs.net bash -c "'uname -a'"`
exec a local script<br /> exec a local script
&nbsp;&nbsp;`ssh envs.net 'bash -s' < local_script.sh` &nbsp;&nbsp;`ssh envs.net 'bash -s' < local_script.sh`
## # scp usage ## # scp usage
copy ssh pub key to remote:<br /> copy ssh pub key to remote:
&nbsp;&nbsp;`scp -P 2223 ~/.ssh/authorized_keys user@envs.net:~/.ssh/authorized_keys` &nbsp;&nbsp;`scp -P 2223 ~/.ssh/authorized_keys user@envs.net:~/.ssh/authorized_keys`
copy website index.html from remote:<br /> copy website index.html from remote:
&nbsp;&nbsp;`scp -P 2223 user@envs.net:~/public_www/index.html ~/public_www/` &nbsp;&nbsp;`scp -P 2223 user@envs.net:~/public_www/index.html ~/public_www/`
## # rsync usage ## # rsync usage
sync website to remote:<br /> sync website to remote:
&nbsp;&nbsp;`rsync -avz -e "ssh -p 2223" ~/public_www user@envs.net:~`<br /> &nbsp;&nbsp;`rsync -avz -e "ssh -p 2223" ~/public_www user@envs.net:~`
sync website from remote:<br /> sync website from remote:
&nbsp;&nbsp;`rsync -avz -e "ssh -p 2223" user@envs.net:~/public_www ~/`<br /> &nbsp;&nbsp;`rsync -avz -e "ssh -p 2223" user@envs.net:~/public_www ~/`
## # sftp usage ## # sftp usage
connect: `sftp -oPort=2223 user@envs.net` connect: `sftp -oPort=2223 user@envs.net`
### commands: ### commands:
exit: `exit`<br /> exit: `exit`
print help: `help` print help: `help`
### transferring ### transferring
files to remote:<br /> files to remote:
&nbsp;&nbsp;`put localfile remotefile` &nbsp;&nbsp;`put localfile remotefile`
dir to remote:<br /> dir to remote:
&nbsp;&nbsp;`put -r localdir remotedir` &nbsp;&nbsp;`put -r localdir remotedir`
files from remote:<br /> files from remote:
&nbsp;&nbsp;`get remotefile localfile` &nbsp;&nbsp;`get remotefile localfile`
dir from remote:<br /> dir from remote:
&nbsp;&nbsp;`get -r remotedir localdir` &nbsp;&nbsp;`get -r remotedir localdir`
### example: ### example:
add index.html to public_www Dir:<br /> add index.html to public_www Dir:
&nbsp;&nbsp;`put public_www/index.html public_www` &nbsp;&nbsp;`put public_www/index.html public_www`
add `~/.ssh/authorized_keys:`<br /> add `~/.ssh/authorized_keys:`
&nbsp;&nbsp;`put .ssh/authorized_keys .ssh/authorized_keys` &nbsp;&nbsp;`put .ssh/authorized_keys .ssh/authorized_keys`
### single line usage (on local machine) ### single line usage (on local machine)
&nbsp;&nbsp;to remote: `sftp -P 2223 user@envs.net:remotedir <<< $'put localfile_path'`<br /> &nbsp;&nbsp;to remote: `sftp -P 2223 user@envs.net:remotedir <<< $'put localfile_path'`
&nbsp;&nbsp;from remote: `sftp -P 2223 user@envs.net:remotefile localfile` &nbsp;&nbsp;from remote: `sftp -P 2223 user@envs.net:remotefile localfile`
## # your shell ## # your shell
avaliable shells: `ash`, `bash`, `csh`, `dash`, `elvish`, `fish`, `ksh`, `mksh`, `sash`, `sh`, `tcsh`, `xonsh`, `yash`, `zsh`<br /> avaliable shells: `ash`, `bash`, `csh`, `dash`, `elvish`, `fish`, `ksh`, `mksh`, `sash`, `sh`, `tcsh`, `xonsh`, `yash`, `zsh`
*list all available shells: `more /etc/shells`* *list all available shells: `more /etc/shells`*
to change your shell use: `chsh -s $(which <shell>)`<br /> to change your shell use: `chsh -s $(which <shell>)`
or `chsh -s <path_to_shell>` or `chsh -s <path_to_shell>`
example: `chsh -s $(which bash)` or `chsh -s /bin/bash` example: `chsh -s $(which bash)` or `chsh -s /bin/bash`
### default byobu-session ### default byobu-session
familiar with tmux, continue as normal, but with ctrl-a instead of ctrl-b<br> familiar with tmux, continue as normal, but with ctrl-a instead of ctrl-b
if you don't want to this happen by default when you log in, run `byobu-disable`.<br> if you don't want to this happen by default when you log in, run `byobu-disable`.
`man byobu` for more info. `man byobu` for more info.
press shift-f1 for a full list of keybinds<br> press shift-f1 for a full list of keybinds
f2 creates a new tab<br> f2 creates a new tab
f3 and f4 move you between tabs<br> f3 and f4 move you between tabs
f6 disconnects and leaves everything running<br> f6 disconnects and leaves everything running
shift-f12 disable/enable byobu f-key bindings shift-f12 disable/enable byobu f-key bindings
## # timezone ## # timezone
The timezone by default on the server is UTC. The timezone by default on the server is UTC.
If you want to make it so that your shell prints out dates in localtime for you,<br /> If you want to make it so that your shell prints out dates in localtime for you,
run `tzselect` to find the correct timezone name that you’ll need to export as the TZ environment variable. run `tzselect` to find the correct timezone name that you’ll need to export as the TZ environment variable.
for example, if you’re in eastern time, add something like this<br /> for example, if you’re in eastern time, add something like this
`export TZ="America/Detroit"`<br /> `export TZ="America/Detroit"`
to your `~/.profile`. to your `~/.profile`.
to get your timezone you can use `date`. to get your timezone you can use `date`.
@ -203,13 +207,13 @@ to get your timezone you can use `date`.
the linux utilities `cron` and `at` are related commands. you might use crontab, for example, to perform a task each morning at 2 a.m., and use at to remind yourself of an appointment later in the day. the linux utilities `cron` and `at` are related commands. you might use crontab, for example, to perform a task each morning at 2 a.m., and use at to remind yourself of an appointment later in the day.
### cron/crontab ### cron/crontab
the cron utility allows you to schedule a repetitive task to take place at any regular interval desired.<br /> the cron utility allows you to schedule a repetitive task to take place at any regular interval desired.
for more information see the manual pages of crontab(5) and cron(8) for more information see the manual pages of crontab(5) and cron(8)
display current crontabs:<br /> display current crontabs:
&nbsp;&nbsp;`crontab -l` &nbsp;&nbsp;`crontab -l`
add/edit crontabs:<br /> add/edit crontabs:
&nbsp;&nbsp;`crontab -e` &nbsp;&nbsp;`crontab -e`
example: - backup your mysql db once per day example: - backup your mysql db once per day
@ -237,15 +241,15 @@ echo 'sh myscript.sh' | at 10:00 AM Sun
echo 'sh myscript.sh' | at midnight echo 'sh myscript.sh' | at midnight
``` ```
view your at queue:<br /> view your at queue:
&nbsp;&nbsp;`at -l` or `atq`<br /> &nbsp;&nbsp;`at -l` or `atq`
`2 Sun Dec 29 14:03:00 2019 a creme` `2 Sun Dec 29 14:03:00 2019 a creme`
delete at job id 2:<br /> delete at job id 2:
&nbsp;&nbsp;`at -r 2` or `atrm 2` &nbsp;&nbsp;`at -r 2` or `atrm 2`
## # daemonize processes ## # daemonize processes
so you've got a process that you want to keep running. you might have it in a<br /> so you've got a process that you want to keep running. you might have it in a
tmux or screen session. let's use systemd user units to manage it! tmux or screen session. let's use systemd user units to manage it!
- ensure that your user unit loadpath is set up:<br />`mkdir -p ~/.config/systemd/user/` - ensure that your user unit loadpath is set up:<br />`mkdir -p ~/.config/systemd/user/`
@ -261,5 +265,5 @@ WantedBy=default.target
- enable it:<br>`systemctl --user enable --now my-new-service.service` - enable it:<br>`systemctl --user enable --now my-new-service.service`
- enable-linger for your user account:<br />`loginctl enable-linger`<br />this allows your user units to run even when you're not logged in. - enable-linger for your user account:<br />`loginctl enable-linger`<br />this allows your user units to run even when you're not logged in.
done!<br /> done!
you can now use `systemctl --user` to manage your daemonized process. you can now use `systemctl --user` to manage your daemonized process.

30
docs/index.md
View File

@ -13,7 +13,7 @@
*if you need more (mailbox-)storage space for your work then feel free to contact us.* *if you need more (mailbox-)storage space for your work then feel free to contact us.*
- some more services like:<br /> - some more services like:
[website](https://help.envs.net/website/) / [website](https://help.envs.net/website/) /
[blog](https://help.envs.net/blog/) / [blog](https://help.envs.net/blog/) /
[databases](https://help.envs.net/database/) / [databases](https://help.envs.net/database/) /
@ -25,9 +25,9 @@
## services ## services
### # code related stuff ### # code related stuff
- [gitea](https://git.envs.net/) - git with a cup of tea. - lightweight code hosting solution.<br /> - [gitea](https://git.envs.net/) - git with a cup of tea. - lightweight code hosting solution.
members can be use your email credantials for login. (*user@envs.net* | *your email pw*) members can be use your email credantials for login. (*user@envs.net* | *your email pw*)
- [drone](https://drone.envs.net/) - drone is a container-native, continuous delivery platform.<br /> - [drone](https://drone.envs.net/) - drone is a container-native, continuous delivery platform.
(includes a "drone-ssh-runner" and "drone-docker-runner".) (includes a "drone-ssh-runner" and "drone-docker-runner".)
### # general utilities ### # general utilities
@ -71,21 +71,31 @@ members can be use your email credantials for login. (*user@envs.net* | *your em
- [cinny](https://cinny.envs.net/) - cinny is a matrix client focusing primarily on simple, elegant and secure interface. - [cinny](https://cinny.envs.net/) - cinny is a matrix client focusing primarily on simple, elegant and secure interface.
- [dimension](https://dimension.envs.net/) - an open source integrations manager for matrix clients, like element. - [dimension](https://dimension.envs.net/) - an open source integrations manager for matrix clients, like element.
***note: we have a bridge between the channels `#envs` `#envs_news` `#envs_lounge` and `#envs_german` on matrix and irc.***
- [irc](https://envs.net/chat/irc/) - irc network for the tildeverse - [irc](https://envs.net/chat/irc/) - irc network for the tildeverse
- [thelounge](https://webirc.envs.net/) - irc webclient - runs in private mode: it stays connected for you. run `webirc` to create a login. - [thelounge](https://webirc.envs.net/) - irc webclient - runs in private mode: it stays connected for you. run `webirc` to create a login.
- [znc](https://znc.envs.net/) - irc bouncer - please contact [creme](https://envs.net/~creme/) (via irc/matrix or email) to request an account, then log in with your email password and configure as needed. - [znc](https://znc.envs.net/) - irc bouncer - please contact [creme](https://envs.net/~creme/) (via irc/matrix or email) to request an account, then log in with your email password and configure as needed.
!!! note
we have a bridge between the channels:
- [`#envs`](https://matrix.to/#/#envs:envs.net) - official channel for envs.net
- [`#envs_german:envs.net`](https://matrix.to/#/#envs_german:envs.net) - german speaking project channel
- [`#envs_news`](https://matrix.to/#/#envs_news:envs.net) - news / announcements about envs.net
- [`#envs_status`](https://matrix.to/#/#envs_status:envs.net) - status notifications for envs services
- [`#envs_lounge`](https://matrix.to/#/#envs_lounge:envs.net) - hang out in the #lounge | ~ offtopic chat ~
on matrix and irc. more informations about can you find [here](https://matrix-help.envs.net/advanced/irc_bridge/).
### # public dns-server ### # public dns-server
**host:** `dns.envs.net`<br /> **host:** `dns.envs.net`
**ip:** `5.199.130.141`<br /> **ip:** `5.199.130.141`
**port:** `53` **port:** `53`
#### dns-over-tls (dot) #### dns-over-tls (dot)
**host:** `dns.envs.net`<br /> **host:** `dns.envs.net`
**ip:** `5.199.130.141`<br /> **ip:** `5.199.130.141`
**port:** `853`<br /> **port:** `853`
**tls_pubkey_pinset:** `TknTKtNi/lhE270MszuUQlgqk1HnGcUXFAgXSXURD7k=` _(**digest:** `sha256`)_ **tls_pubkey_pinset:** `TknTKtNi/lhE270MszuUQlgqk1HnGcUXFAgXSXURD7k=` _(**digest:** `sha256`)_

2
docs/info.md
View File

@ -9,6 +9,8 @@ status page: [https://status.envs.net/](https://status.envs.net/)
more infos over the installed packages can you find on the [sysinfo page](https://envs.net/sysinfo/)<br /> more infos over the installed packages can you find on the [sysinfo page](https://envs.net/sysinfo/)<br />
as well as summarized in our [sysinfo.json](https://envs.net/sysinfo.json). as well as summarized in our [sysinfo.json](https://envs.net/sysinfo.json).
***
## # sshfp ## # sshfp
| Algorithm | Fingerprint | | Algorithm | Fingerprint |