From 153a6cefd0c50ea9c1a9c39f5f5131ec33372b0a Mon Sep 17 00:00:00 2001
From: MB <michael.blaschek@univie.ac.at>
Date: Fri, 20 Jan 2023 17:32:13 +0100
Subject: [PATCH] fixes img path
---
.devcontainer/devcontainer.json | 26 +++++++++++++++++++
.../devcontainer_20230112114144.json | 25 ++++++++++++++++++
.../devcontainer_20230112115149.json | 22 ++++++++++++++++
.../devcontainer_20230112115200.json | 22 ++++++++++++++++
.../devcontainer_20230112115202.json | 22 ++++++++++++++++
.../devcontainer_20230112115209.json | 22 ++++++++++++++++
.../devcontainer_20230112115449.json | 24 +++++++++++++++++
Git/README.md | 2 --
Jet-Cluster.md | 6 ++---
Latex/README.md | 3 +--
Misc/README.md | 2 --
Misc/Virtual-Terminals.md | 2 ++
Python/README.md | 2 --
SRVX8.md | 2 +-
SSH-VPN-VNC/Questions.md | 2 +-
SSH-VPN-VNC/README.md | 2 +-
SSH-VPN-VNC/SSH.md | 16 +++++++-----
TeachingHub.md | 14 +++++-----
build_docs.sh | 20 --------------
deploy.sh | 11 --------
mkdocs.yml | 5 +++-
requirements.txt | 1 +
22 files changed, 193 insertions(+), 60 deletions(-)
create mode 100644 .devcontainer/devcontainer.json
create mode 100644 .history/.devcontainer/devcontainer_20230112114144.json
create mode 100644 .history/.devcontainer/devcontainer_20230112115149.json
create mode 100644 .history/.devcontainer/devcontainer_20230112115200.json
create mode 100644 .history/.devcontainer/devcontainer_20230112115202.json
create mode 100644 .history/.devcontainer/devcontainer_20230112115209.json
create mode 100644 .history/.devcontainer/devcontainer_20230112115449.json
delete mode 100644 build_docs.sh
delete mode 100644 deploy.sh
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
new file mode 100644
index 0000000..50db738
--- /dev/null
+++ b/.devcontainer/devcontainer.json
@@ -0,0 +1,26 @@
+
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/python
+{
+ "name": "Python 3",
+ // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+ "image": "mcr.microsoft.com/devcontainers/python:0-3.9",
+
+ // Features to add to the dev container. More info: https://containers.dev/features.
+ // "features": {},
+
+ // Use 'forwardPorts' to make a list of ports inside the container available locally.
+ "forwardPorts": [3000],
+
+ // Use 'postCreateCommand' to run commands after the container is created.
+ "postCreateCommand": "pip3 install --user -r requirements.txt",
+
+ // Configure tool-specific properties.
+ // "customizations": {},
+
+ // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+ // for podman as rootless
+ "runArgs": ["--userns=keep-id"],
+ "remoteUser": "vscode",
+ "containerUser": "vscode"
+}
diff --git a/.history/.devcontainer/devcontainer_20230112114144.json b/.history/.devcontainer/devcontainer_20230112114144.json
new file mode 100644
index 0000000..83a2242
--- /dev/null
+++ b/.history/.devcontainer/devcontainer_20230112114144.json
@@ -0,0 +1,25 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/python
+{
+ "name": "Python 3",
+ // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+ "image": "mcr.microsoft.com/devcontainers/python:0-3.9",
+ "features": {
+ "ghcr.io/devcontainers-contrib/features/mkdocs:2": {}
+ }
+
+ // Features to add to the dev container. More info: https://containers.dev/features.
+ // "features": {},
+
+ // Use 'forwardPorts' to make a list of ports inside the container available locally.
+ // "forwardPorts": [],
+
+ // Use 'postCreateCommand' to run commands after the container is created.
+ // "postCreateCommand": "pip3 install --user -r requirements.txt",
+
+ // Configure tool-specific properties.
+ // "customizations": {},
+
+ // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+ // "remoteUser": "root"
+}
diff --git a/.history/.devcontainer/devcontainer_20230112115149.json b/.history/.devcontainer/devcontainer_20230112115149.json
new file mode 100644
index 0000000..1f6e93f
--- /dev/null
+++ b/.history/.devcontainer/devcontainer_20230112115149.json
@@ -0,0 +1,22 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/python
+{
+ "name": "Python 3",
+ // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+ "image": "mcr.microsoft.com/devcontainers/python:0-3.9",
+
+ // Features to add to the dev container. More info: https://containers.dev/features.
+ // "features": {},
+
+ // Use 'forwardPorts' to make a list of ports inside the container available locally.
+ // "forwardPorts": [],
+
+ // Use 'postCreateCommand' to run commands after the container is created.
+ // "postCreateCommand": "pip3 install --user -r requirements.txt",
+
+ // Configure tool-specific properties.
+ // "customizations": {},
+
+ // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+ // "remoteUser": "root"
+}
diff --git a/.history/.devcontainer/devcontainer_20230112115200.json b/.history/.devcontainer/devcontainer_20230112115200.json
new file mode 100644
index 0000000..4d8baff
--- /dev/null
+++ b/.history/.devcontainer/devcontainer_20230112115200.json
@@ -0,0 +1,22 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/python
+{
+ "name": "Python 3",
+ // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+ "image": "mcr.microsoft.com/devcontainers/python:0-3.9"
+
+ // Features to add to the dev container. More info: https://containers.dev/features.
+ // "features": {},
+
+ // Use 'forwardPorts' to make a list of ports inside the container available locally.
+ // "forwardPorts": [],
+
+ // Use 'postCreateCommand' to run commands after the container is created.
+ // "postCreateCommand": "pip3 install --user -r requirements.txt",
+
+ // Configure tool-specific properties.
+ // "customizations": {},
+
+ // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+ // "remoteUser": "root"
+}
diff --git a/.history/.devcontainer/devcontainer_20230112115202.json b/.history/.devcontainer/devcontainer_20230112115202.json
new file mode 100644
index 0000000..1f6e93f
--- /dev/null
+++ b/.history/.devcontainer/devcontainer_20230112115202.json
@@ -0,0 +1,22 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/python
+{
+ "name": "Python 3",
+ // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+ "image": "mcr.microsoft.com/devcontainers/python:0-3.9",
+
+ // Features to add to the dev container. More info: https://containers.dev/features.
+ // "features": {},
+
+ // Use 'forwardPorts' to make a list of ports inside the container available locally.
+ // "forwardPorts": [],
+
+ // Use 'postCreateCommand' to run commands after the container is created.
+ // "postCreateCommand": "pip3 install --user -r requirements.txt",
+
+ // Configure tool-specific properties.
+ // "customizations": {},
+
+ // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+ // "remoteUser": "root"
+}
diff --git a/.history/.devcontainer/devcontainer_20230112115209.json b/.history/.devcontainer/devcontainer_20230112115209.json
new file mode 100644
index 0000000..dd3869b
--- /dev/null
+++ b/.history/.devcontainer/devcontainer_20230112115209.json
@@ -0,0 +1,22 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/python
+{
+ "name": "Python 3",
+ // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+ "image": "mcr.microsoft.com/devcontainers/python:0-3.9",
+
+ // Features to add to the dev container. More info: https://containers.dev/features.
+ // "features": {},
+
+ // Use 'forwardPorts' to make a list of ports inside the container available locally.
+ // "forwardPorts": [],
+
+ // Use 'postCreateCommand' to run commands after the container is created.
+ "postCreateCommand": "pip3 install --user -r requirements.txt",
+
+ // Configure tool-specific properties.
+ // "customizations": {},
+
+ // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+ // "remoteUser": "root"
+}
diff --git a/.history/.devcontainer/devcontainer_20230112115449.json b/.history/.devcontainer/devcontainer_20230112115449.json
new file mode 100644
index 0000000..780b4ba
--- /dev/null
+++ b/.history/.devcontainer/devcontainer_20230112115449.json
@@ -0,0 +1,24 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/python
+{
+ "name": "Python 3",
+ // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+ "image": "mcr.microsoft.com/devcontainers/python:0-3.9",
+
+ // Features to add to the dev container. More info: https://containers.dev/features.
+ // "features": {},
+
+ // Use 'forwardPorts' to make a list of ports inside the container available locally.
+ // "forwardPorts": [],
+
+ // Use 'postCreateCommand' to run commands after the container is created.
+ "postCreateCommand": "pip3 install --user -r requirements.txt",
+
+ // Configure tool-specific properties.
+ // "customizations": {},
+
+ // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+ // "remoteUser": "root"
+ "containerUser": "vscode"
+
+}
diff --git a/Git/README.md b/Git/README.md
index ad06984..6572d61 100644
--- a/Git/README.md
+++ b/Git/README.md
@@ -1,8 +1,6 @@
# Git Tipps and Tools
There is a lot of ways how to use git and sometimes a working solution can be very helpful for everybody. So please share you experience and working solutions.
-[[_TOC_]]
-
## HowTo add a specif ssh-key for your git account
Sometimes it might be useful to have different ssh-keys per project or have a special ssh-key just for github/gitlab.
diff --git a/Jet-Cluster.md b/Jet-Cluster.md
index 020e0eb..3b1c037 100644
--- a/Jet-Cluster.md
+++ b/Jet-Cluster.md
@@ -155,11 +155,11 @@ Steps:
- Choose a job
- The jupyterlab will be launched and will be available to you until you log out or the wall time exceeds.
-<img src="/mkdocs/img/jet-login.png" width="500px">
+<img src="./mkdocs/img/jet-login.png" width="500px">
-<img src="/mkdocs/img/jet-job1.png" width="500px">
+<img src="./mkdocs/img/jet-job1.png" width="500px">
-<img src="/mkdocs/img/jet-job2.png" width="500px">
+<img src="./mkdocs/img/jet-job2.png" width="500px">
There are several kernels available and some help can be found:
diff --git a/Latex/README.md b/Latex/README.md
index b8e2af1..9079dcf 100644
--- a/Latex/README.md
+++ b/Latex/README.md
@@ -11,8 +11,7 @@ What you need to get started:
* other [Examples](https://www.latextemplates.com)
* More [Overleaf-Examples](https://de.overleaf.com/latex/examples)
-[Advanced Guide to writing scientific papers with $`\LaTeX`$ (Wissenschaftliche Arbeiten schreiben mit $`\LaTeX`$
-)](Wissenschaftliches-Script-Latex-Seibert-05.2021.pdf) or the [latest](https://homepage.univie.ac.at/petra.seibert/files/latexscript.pdf)
+[Advanced Guide to writing scientific papers with $`\LaTeX`$ (Wissenschaftliche Arbeiten schreiben mit $`\LaTeX`$ )](Wissenschaftliches-Script-Latex-Seibert-05.2021.pdf) or the [latest](https://homepage.univie.ac.at/petra.seibert/files/latexscript.pdf)
# What to use?
diff --git a/Misc/README.md b/Misc/README.md
index 19112c8..c683ad4 100644
--- a/Misc/README.md
+++ b/Misc/README.md
@@ -1,7 +1,5 @@
# Miscellaneous Topics
-[[_TOC_]]
-
## Customize your shell
On a Linux system there are numerous ways of customizing user experience. And of course there is a way to customize the shell. It should be common by now, that people use [BASH](https://de.wikipedia.org/wiki/Bash_(Shell)), if not run `chsh -s /bin/bash` in your terminal and if you are not sure run `echo $SHELL` wich should show bash.
diff --git a/Misc/Virtual-Terminals.md b/Misc/Virtual-Terminals.md
index 0724f93..e8c84f0 100644
--- a/Misc/Virtual-Terminals.md
+++ b/Misc/Virtual-Terminals.md
@@ -3,7 +3,9 @@
in Linux it is quite common to have virtual terminals or mulitplexer, which allows to have multiple terminal sessions in one window. This is similar to the `nohup` command which does not send a "hangup" (SIGHUP) signal, therefore continues to run. Running a VNC-Session is similar but is used for graphical applications mainly.
There are especially [**tmux**](https://en.wikipedia.org/wiki/Tmux) and [**screen**](https://en.wikipedia.org/wiki/GNU_Screen) that are widely used on HPC or servers.
+
+
Although tmux and screen work similarly, it shall be noted that tmux os prefered.
diff --git a/Python/README.md b/Python/README.md
index 99122a3..10077fd 100644
--- a/Python/README.md
+++ b/Python/README.md
@@ -1,6 +1,5 @@
# Python related Problems
-[[_TOC_]]
## Introduction to conda / micromamba
@@ -67,7 +66,6 @@ Some are:
- Jupyter Notebooks and Lab e.g. on `Jupyterhub@srvx1` or `jupyterhub@jet`
and `atom`. This is simple editor available on any platform and it can be extended with packages to become a full grown IDE with the power of open source.
- [Atom-IDE-Install](QA-006-Atom-IDE.md)
## Q: How to add a new package to anaconda module?
diff --git a/SRVX8.md b/SRVX8.md
index 01bebcc..37c4a1f 100644
--- a/SRVX8.md
+++ b/SRVX8.md
@@ -55,7 +55,7 @@ Major Libraries:
These software libraries are usually handled by environment modules.
-
+
## Currently installed modules
diff --git a/SSH-VPN-VNC/Questions.md b/SSH-VPN-VNC/Questions.md
index b322fb2..e787c34 100644
--- a/SSH-VPN-VNC/Questions.md
+++ b/SSH-VPN-VNC/Questions.md
@@ -53,7 +53,7 @@ ssh-agent -k
[Nice summary of how an ssh-agent works](https://smallstep.com/blog/ssh-agent-explained/)
-<img src="https://keepassxc.org/images/keepassxc-logo.svg" height="200px">
+<img src="https://keepassxc.org/images/keepassxc-logo.svg" width="200px">
Keep in mind that you can use the ssh-agent with [KeepassXC](https://keepassxc.org/docs/#faq-ssh-agent-how), find a nice tutorial [here](https://ferrario.me/using-keepassxc-to-manage-ssh-keys/). This is really convenient as it allows you to use all keys in the Keepass as long as it is unlocked. The keys will be automatically removed when the keepass is locked. :)
diff --git a/SSH-VPN-VNC/README.md b/SSH-VPN-VNC/README.md
index 251cac0..a352a77 100644
--- a/SSH-VPN-VNC/README.md
+++ b/SSH-VPN-VNC/README.md
@@ -36,7 +36,7 @@ You can detach from this session with `CTRL + A D` and reconnect again with `scr
Multiple Sessions can be created and the output saved (`-L` Option).
-
+
## Tmux
[Tmux](https://wiki.ubuntuusers.de/tmux/) is a terminal multiplexer, that allows to open more consoles and allows to detach the session. It is much more complex and powerful compared to screen.
diff --git a/SSH-VPN-VNC/SSH.md b/SSH-VPN-VNC/SSH.md
index 21f877a..00d9f65 100644
--- a/SSH-VPN-VNC/SSH.md
+++ b/SSH-VPN-VNC/SSH.md
@@ -62,6 +62,14 @@ and replacing `[USERNAME]` and `[U:Account USERNAME]` with your usernames. Using
Please note the special algorithms for ecaccess.
+**From eduroam**: You should be able to log in as above.
+
+**From the outer world**: First connect to the [UniVie VPN](https://zid.univie.ac.at/en/vpn/), then start up a terminal and log in as above. Consider using [connect2vpn](connect2vpn) script to do so. Set your U:Account username as environmental variable `$VPN_USER` and run `connect2vpn`, select split (only adresses within the UNINET) or full (all connections) tunnel and watch the connection information update every 10 seconds.
+
+If you are a guest, you can apply for a [guest u:account](https://zid.univie.ac.at/uaccount/#c11096). This will give you access to eduroam and to the VPN. Your application needs to be endorsed by a staff member, who also determines the expiration date of the account.
+
+## SSH Authentication with keys
+
If you want to use ssh-keys you can also use different keys in `.ssh/config` per server with `IdentityFile ~/.ssh/id_rsa_for_server`.
**Note: If you are having trouble with your ssh-key being accepted. You need to check the selinux security policy. Because we use non standard home directories, which are not accepted by default.** Do that by running:
@@ -74,13 +82,7 @@ ls -lZ ~/.ssh/
```
If you are not seeing `ssh_home_t` than you need to run `restorecon -Rv ~/.ssh/` which should update the security policy and allow for the SSH-Daemon to accept your keys.
-**From eduroam**: You should be able to log in as above.
-
-**From the outer world**: First connect to the [UniVie VPN](https://zid.univie.ac.at/en/vpn/), then start up a terminal and log in as above. Consider using [connect2vpn](connect2vpn) script to do so. Set your U:Account username as environmental variable `$VPN_USER` and run `connect2vpn`, select split (only adresses within the UNINET) or full (all connections) tunnel and watch the connection information update every 10 seconds.
-
-If you are a guest, you can apply for a [guest u:account](https://zid.univie.ac.at/uaccount/#c11096). This will give you access to eduroam and to the VPN. Your application needs to be endorsed by a staff member, who also determines the expiration date of the account.
-
-## SSH Authentication with keys
+**Please add your ssh-keys via [IPA](IPA.md#add-ssh-key)**
Find a solution [Questions - How to use ssh-key authentication?](Questions.md#q-how-to-use-ssh-key-authentication) or [Questions - How to use an ssh-agent?](Questions.md#q-how-to-use-an-ssh-agent)
diff --git a/TeachingHub.md b/TeachingHub.md
index 2698e1c..485903a 100644
--- a/TeachingHub.md
+++ b/TeachingHub.md
@@ -1,6 +1,6 @@
# Teaching Hub
-<img src="/mkdocs/img/jupyterhub-logo.svg" width="100px">
+<img src="./mkdocs/img/jupyterhub-logo.svg" width="100px">
## Getting Started
Address: [https://srvx1.img.univie.ac.at/hub](https://srvx1.img.univie.ac.at/hub)
@@ -37,22 +37,22 @@ As stated in the email you received, you need to download one of these TOTP apps
I recommend using your phone and an app there, as this is the most secure way. And with you phone you can scan the qr code, which looks like this:
-<img src="/mkdocs/img/teachinghub-qrcode.png" width="300px">
+<img src="./mkdocs/img/teachinghub-qrcode.png" width="300px">
When you scan to your Authenticator App, it will automatically get the details (username, Secret) required to generate every 30 seconds a Time-based One Time Password (TOTP). Like this:
-
+
If you want to use a desktop or other app that might not scan QR codes, you can fill in the details manually like this:
- Provider: `TeachingHub`
- Account: `[user]` your username, here `monkey`
- Token or Secret or Hash: `1A2B3C4D5E6F7G8H` is the secret from your email.
-
+
The combination of username, password and TOTP needs to be used to sign in:
-
+
This sounds all really complicated, but I promise this will be easier from time to time. Don't forget that this for our all security and your contribution is appreciated! Thanks.
@@ -67,13 +67,13 @@ Now you are ready to go to the teaching hub and sign in:
Currently there are several Notebooks with different Kernels (Python kernels) installed at SRVX1. Look at the logos, if SRVX1 is in there then you will have access to these notebooks and kernels. If SRVX2 or SRVX8 are in the logo you might not have access as this is for researchers.
-
+
As you can see it is also possible to launch a terminal inside the TeachingHub and you will find you files from your home directory there.
It might be that your course has a separate Notebook/Kernel for you, with installed packages and dependencies required for this specific course. However, these Notebooks/Kernels are only available during these lectures and might be removed in the future. So be aware of that. Note that you can easily change a kernel in your notebook. So no need to delete, copy or do anything. Your data/notebook information is safe.
-
+
diff --git a/build_docs.sh b/build_docs.sh
deleted file mode 100644
index 963b037..0000000
--- a/build_docs.sh
+++ /dev/null
@@ -1,20 +0,0 @@
-#!/bin/bash
-# By MB
-# Build a mkdocs Documentation from existing Documentation
-# requires jupyter-nbconvert
-
-DOCS="./docs"
-
-# Go through all directories creating a similar structure in docs.
-
-# Add tags to Markdown files
-#---
-#tags:
-# - Python
-# - JET
-#---
-
-# Build pages
-
-mkdocs build
-# Copy to the correct location
\ No newline at end of file
diff --git a/deploy.sh b/deploy.sh
deleted file mode 100644
index 57d5767..0000000
--- a/deploy.sh
+++ /dev/null
@@ -1,11 +0,0 @@
-#!/bin/bash
-# By MB
-# Deploy documentation to web root
-
-if [ $EUID -ne 0 ]; then
- echo "Run as root"
- exit 1
-fi
-echo "Deploying to /var/www/html/docs"
-mkdir -p /var/www/html/docs
-mkdocs build -d /var/www/html/docs
diff --git a/mkdocs.yml b/mkdocs.yml
index 898a0ef..a23ecac 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -24,7 +24,6 @@ theme:
favicon: mkdocs/img/favicon.ico
custom_dir: mkdocs/overrides
plugins:
- - tags
- same-dir
- search
- mkdocs-jupyter:
@@ -33,6 +32,10 @@ plugins:
enable_creation_date: true
- awesome-pages
# collapse_single_pages: true
+ - tags
+ - exclude:
+ glob:
+ - testing/*
extra:
social:
diff --git a/requirements.txt b/requirements.txt
index d99982d..56c1de5 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -8,3 +8,4 @@ mkdocs-awesome-pages-plugin
mkdocs-git-revision-date-localized-plugin
mkdocs-jupyter
mkdocs-same-dir
+mkdocs-exclude
\ No newline at end of file
--
GitLab