Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixing Check Syntax Errors and Warnings #267

Merged
merged 9 commits into from
Jul 24, 2024
3 changes: 1 addition & 2 deletions nextbox/backup-restore.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To enable backup and restore onto a storage device please follow these steps:
(currently *ext* and *xfs* are supported).

2. Attach the storage device to your NextBox to any of the USB ports and *remember to use an external
power supply* (:ref:`more information<usb-power-supply>`)
power supply* `more information <faq/hardware.html#why-must-i-not-connect-external-hard-drives-without-an-external-power-supply-to-my-nextbox>`_

3. Once attached you will see the storage(s) inside "Storage Management" below "Available Storages"

Expand Down Expand Up @@ -65,6 +65,5 @@ the upgrade process for Nextcloud.
is not identical to the current one.


.. _Nextcloud WebDAV documentation: https://docs.nextcloud.com/server/20/user_manual/en/files/access_webdav.html


1 change: 0 additions & 1 deletion nextbox/faq/generic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ Generic FAQ
and passwords are on a high level, either with long-random passwords or a
2-Factor-Authentification supported login method with e.g., a Nitrokey FIDO2.**

.. _faq-nextbox-generic-ssh:

**Q:** What do all the ssh-related "warnings" mean?
Once you set up your ssh-access, you make yourself technically responsible for
Expand Down
12 changes: 3 additions & 9 deletions nextbox/faq/hardware.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@ Hardware FAQ
============


.. _usb-power-supply:
.. _faq-nextbox-hardware-usb-power-supply:


**Q:** Why must I not connect external hard-drives without an external power-supply to my NextBox?
The Raspberry Pi 4 Model B can only supply 1.2A of power through USB (see
Expand Down Expand Up @@ -62,13 +61,8 @@ Hardware FAQ
No, the Raspberry PI 4B has the RAM component soldered onto the mainboard, thus it cannot be replaced/extended.


.. _USB Documentation: https://www.raspberrypi.org/documentation/hardware/raspberrypi/usb/README.md
.. _USB Documentation: https://www.raspberrypi.com/documentation/computers/raspberry-pi.html#universal-serial-bus-usb
.. _NextBox' GitHub: https://github.com/Nitrokey/nextbox-board
.. _nextbox.local: http://nextbox.local
.. _External storage support: https://docs.nextcloud.com/server/20/admin_manual/configuration_files/external_storage_configuration_gui.html
.. _RPi Power Supply: https://www.raspberrypi.org/documentation/hardware/raspberrypi/power/README.md
.. _typical bare-board power consumption: https://www.raspberrypi.org/documentation/hardware/raspberrypi/power/README.md
.. _Putty Documentation: https://www.ssh.com/academy/ssh/putty/public-key-authentication
.. _Nextcloud WebDAV documentation: https://docs.nextcloud.com/server/20/user_manual/en/files/access_webdav.html

.. _RPi Power Supply: https://www.raspberrypi.com/documentation/computers/raspberry-pi.html#power-supply

10 changes: 1 addition & 9 deletions nextbox/faq/nextcloud.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,20 +41,12 @@ Nextcloud FAQ
**Q:** Why is my Nextcloud not loading properly, instead I get a white page and a `.htaccess` error?
This usually is an indication that the OS has unmounted/detached the internal
hard-drive due to an low-power-incident. Please make sure you read and
understood :ref:`USB power<faq-nextbox-hardware-usb-power-supply>`. In most
understood `USB power <faq/hardware.html#why-must-i-not-connect-external-hard-drives-without-an-external-power-supply-to-my-nextbox>`_. In most
cases doing a power-cycle (unplug the USB-C connector, wait 5secs and plug it
in again) should resolve this. **Make sure no additional USB devices are
connected during this procedure.**



.. _USB Documentation: https://www.raspberrypi.org/documentation/hardware/raspberrypi/usb/README.md
.. _NextBox' GitHub: https://github.com/Nitrokey/nextbox-board
.. _nextbox.local: http://nextbox.local
.. _External storage support: https://docs.nextcloud.com/server/20/admin_manual/configuration_files/external_storage_configuration_gui.html
.. _RPi Power Supply: https://www.raspberrypi.org/documentation/hardware/raspberrypi/power/README.md
.. _typical bare-board power consumption: https://www.raspberrypi.org/documentation/hardware/raspberrypi/power/README.md
.. _Putty Documentation: https://www.ssh.com/academy/ssh/putty/public-key-authentication
.. _Nextcloud WebDAV documentation: https://docs.nextcloud.com/server/20/user_manual/en/files/access_webdav.html


7 changes: 0 additions & 7 deletions nextbox/faq/remote-access.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 +61,6 @@ Remote Access FAQ



.. _USB Documentation: https://www.raspberrypi.org/documentation/hardware/raspberrypi/usb/README.md
.. _NextBox' GitHub: https://github.com/Nitrokey/nextbox-board
.. _nextbox.local: http://nextbox.local
.. _External storage support: https://docs.nextcloud.com/server/20/admin_manual/configuration_files/external_storage_configuration_gui.html
.. _RPi Power Supply: https://www.raspberrypi.org/documentation/hardware/raspberrypi/power/README.md
.. _typical bare-board power consumption: https://www.raspberrypi.org/documentation/hardware/raspberrypi/power/README.md
.. _Putty Documentation: https://www.ssh.com/academy/ssh/putty/public-key-authentication
.. _Nextcloud WebDAV documentation: https://docs.nextcloud.com/server/20/user_manual/en/files/access_webdav.html


7 changes: 0 additions & 7 deletions nextbox/faq/software.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,6 @@ Software FAQ


.. _Launchpad NextBox: https://launchpad.net/~nitrokey/+archive/ubuntu/nextbox/+packages
.. _USB Documentation: https://www.raspberrypi.org/documentation/hardware/raspberrypi/usb/README.md
.. _NextBox' GitHub: https://github.com/Nitrokey/nextbox-board
.. _nextbox.local: http://nextbox.local
.. _External storage support: https://docs.nextcloud.com/server/20/admin_manual/configuration_files/external_storage_configuration_gui.html
.. _RPi Power Supply: https://www.raspberrypi.org/documentation/hardware/raspberrypi/power/README.md
.. _typical bare-board power consumption: https://www.raspberrypi.org/documentation/hardware/raspberrypi/power/README.md
.. _Putty Documentation: https://www.ssh.com/academy/ssh/putty/public-key-authentication
.. _Nextcloud WebDAV documentation: https://docs.nextcloud.com/server/20/user_manual/en/files/access_webdav.html


6 changes: 4 additions & 2 deletions nextbox/hardware-overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ the different connectors and interfaces is given.

4. The **RJ45 - 1GbE Ethernet** connector connects your NextBox with your home network and shall
stay connected at all times.
5. **Free USB 3 - Type A Slot**, please see :ref:`Hardware FAQ<usb-power-supply>`
5. **Free USB 3 - Type A Slot**, please see `Hardware FAQ`_
6. **Reserved USB 3 - Type A Slot**, used for the internal hard-disk. *Never remove this connector!*
7. **2x Free USB 2 - Type A Slots**, please see :ref:`Hardware FAQ<usb-power-supply>`
7. **2x Free USB 2 - Type A Slots**, please see `Hardware FAQ`_

.. hint:: Using a hard-drive with an external power supply you can use any of
the available USB slots. Keep in mind that the data transfer bandwidth for
Expand All @@ -75,3 +75,5 @@ the different connectors and interfaces is given.




.. _Hardware FAQ: faq/hardware.html#why-must-i-not-connect-external-hard-drives-without-an-external-power-supply-to-my-nextbox
1 change: 0 additions & 1 deletion nextbox/remote/walkthrough.rst
Original file line number Diff line number Diff line change
Expand Up @@ -180,4 +180,3 @@ If you encounter problems, please read the other articles inside the
.. _TLS: https://en.wikipedia.org/wiki/Transport_Layer_Security
.. _HTTPS: https://en.wikipedia.org/wiki/HTTPS
.. _CA: https://en.wikipedia.org/wiki/Certificate_authority
.. _Let's Encrypt: https://en.wikipedia.org/wiki/Let%27s_Encrypt
76 changes: 38 additions & 38 deletions nitropc/qubes/gpu-install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,42 +29,42 @@ Create a Windows Qube

2. Install the Qubes Windows Tools, in dom0 : ``sudo qubes-dom0-update qubes-windows-tools-4.1.69`` when asked press ``y`` and enter.

.. note::
Please see the `security implication <https://github.com/QubesOS/qubes-secpack/blob/master/QSBs/qsb-091-2023.txt>`__ of installing QWT.
.. note::
Please see the `security implication <https://github.com/QubesOS/qubes-secpack/blob/master/QSBs/qsb-091-2023.txt>`__ of installing QWT.

3. Make the install script executable, in dom0 : ``sudo chmod +x /install.sh``

4. Launch the install script, in dom0 : ``/install.sh``

If you see this message : ``[+] Installation complete!`` then you can continue.
If you see this message : ``[+] Installation complete!`` then you can continue.

At this point the script created a new Qube called windows-mgmt now we will dowload the ISO to create the Windows Qube.
At this point the script created a new Qube called windows-mgmt now we will dowload the ISO to create the Windows Qube.

To do so we need to copy the ``~/qvm-create-windows-qube/windows/isos/mido.sh`` script from the windows-mgmt Qube inside a disposable Qube with internet connectivity.
To do so we need to copy the ``~/qvm-create-windows-qube/windows/isos/mido.sh`` script from the windows-mgmt Qube inside a disposable Qube with internet connectivity.

5. Start a new DVM (disposable) Qube and give it at least 10 GB of private storage.

6. Start the windows-mgmt Qube and copy the script, in windows-mgmt Qube : ``qvm-copy qvm-create-windows-qube/windows/isos/mido.sh`` then select the DVM Qube (dispXXXX).

7. Once the script is copied launch it, in dispXXX : ``./QubesIncoming/windows-mgmt/mido.sh win10x64``

.. note::
In this guide we install Windows 10 but other Windows versions are available you can list them by using ``./QubesIncoming/windows-mgmt/mido.sh``
.. note::
In this guide we install Windows 10 but other Windows versions are available you can list them by using ``./QubesIncoming/windows-mgmt/mido.sh``


8. If you get a success message then you will need to copy the dowloaded ISO from the DVM to the windows-mgmt Qube, in dispXXXX : ``qvm-copy QubesIncoming/windows-mgmt/win10x64.iso`` and choose the windows-mgmt Qube.

Once copied you can close your DVM Qube.
Once copied you can close your DVM Qube.

9. In the windows-mgmt Qube : ``mv QubesIncoming/dispXXXX/win10x64.iso qvm-create-windows-qube/windows/isos/`` (replace 'dispXXXX' with the name of the disposable Qube you created).

10. Then in dom0 : ``qvm-create-windows-qube -n sys-firewall -oy -i win10x64.iso -a win10x64-pro.xml work-win10``

.. note::
You can pre-install any package from `this site <https://community.chocolatey.org/packages>`__.
E.g: ``qvm-create-windows-qube -n sys-firewall -oyp firefox,notepadplusplus,office365proplus -i win10x64.iso -a win10x64-pro.xml work-win10``
.. note::
You can pre-install any package from `this site <https://community.chocolatey.org/packages>`__.
E.g: ``qvm-create-windows-qube -n sys-firewall -oyp firefox,notepadplusplus,office365proplus -i win10x64.iso -a win10x64-pro.xml work-win10``

If the script stops or if it get stuck retry until you see this message: ``[+] Completed successfully!``
If the script stops or if it get stuck retry until you see this message: ``[+] Completed successfully!``

11. Now you will need to attach your GPU to the Windows Qube, to do so go to the Qube Manager and the Windows 10 Qube options (make sure that the Qube is shut down), under the Devices tab select your graphic card and pass it to the right then click on the ``Configure strict reset for PCI devices`` then select your card and click ``OK``

Expand Down Expand Up @@ -99,46 +99,46 @@ Debian

7. ``sudo apt install nvidia-driver dbus-x11``

Now you will need to create 3 differents files:
Now you will need to create 3 differents files:


screen.conf::
screen.conf::

Section "Device"
Identifier "GPU"
Section "Device"
Identifier "GPU"

# name of the driver to use. Can be "amdgpu", "nvidia", or something else
Driver "nvidia"
# name of the driver to use. Can be "amdgpu", "nvidia", or something else
Driver "nvidia"

# The BusID value will change after each qube reboot.
BusID "PCI:0:8:0"
EndSection
# The BusID value will change after each qube reboot.
BusID "PCI:0:8:0"
EndSection

Section "Screen"
Identifier "GPU screen"
Device "GPU"
EndSection
Section "Screen"
Identifier "GPU screen"
Device "GPU"
EndSection


xorgX1.sh::
xorgX1.sh::

#!/bin/bash
#!/bin/bash

binary=${1:?binary required}
binary=${1:?binary required}

# Find the correct BusID of the AMD GPU, then set it in the Xorg configuration file
pci=$(lspci | grep "VGA" | grep -E "NVIDIA|AMD/ATI" | cut -d " " -f 1 | cut -d ":" -f 2 | cut -d "." -f 1 | cut -d "0" -f 2)
sed -i 's/"PCI:[^"]*"/"PCI:0:'$pci':0"/g' /home/user/screen.conf
# Find the correct BusID of the AMD GPU, then set it in the Xorg configuration file
pci=$(lspci | grep "VGA" | grep -E "NVIDIA|AMD/ATI" | cut -d " " -f 1 | cut -d ":" -f 2 | cut -d "." -f 1 | cut -d "0" -f 2)
sed -i 's/"PCI:[^"]*"/"PCI:0:'$pci':0"/g' /home/user/screen.conf

# Start the Xorg server for the X screen number 1.
# The X screen n°0 is already used for QubesOS integration
sudo startx "$binary" -- :1 -config /home/user/screen.conf
# Start the Xorg server for the X screen number 1.
# The X screen n°0 is already used for QubesOS integration
sudo startx "$binary" -- :1 -config /home/user/screen.conf

xfce.sh::
xfce.sh::

#!/bin/bash
sleep 5 && sudo setxkbmap -display :1 fr &
/bin/sudo -u user PULSE_SERVER=unix:/run/user/1000/pulse/native bash -c 'sudo xhost + local:;/usr/bin/startxfce4'
#!/bin/bash
sleep 5 && sudo setxkbmap -display :1 fr &
/bin/sudo -u user PULSE_SERVER=unix:/run/user/1000/pulse/native bash -c 'sudo xhost + local:;/usr/bin/startxfce4'


8. ``sudo chmod +x xorgX1.sh xfce.sh``
Expand Down
36 changes: 18 additions & 18 deletions pro/gpa.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,49 +7,49 @@ This document describes how to use Gnu Privacy Assistant (GPA) to set up the Nit

2. Start GPA and select the Card Manager; either by pressing the icon at the top or by choosing Card Manager in the Windows menu.

.. figure:: /pro/images/gpa/1.png
:alt: img1
.. figure:: /pro/images/gpa/1.png
:alt: img1

3. The window of the Card Manager will appear. Enter your salutation, name and optional other information. While doing so you might be asked to enter the admin PIN.

.. figure:: /pro/images/gpa/2.png
:alt: img2
.. figure:: /pro/images/gpa/2.png
:alt: img2

4. Confirm this window and enter the admin PIN in the next window.

.. figure:: /pro/images/gpa/3.png
:alt: img3
.. figure:: /pro/images/gpa/3.png
:alt: img3

5. In the Card Manager window you might need to scroll down until you see the buttons to change the PINs. The term PIN is used interchangeable with "password". Press the first button "Change PIN" in order to change the user password. Read and confirm the following information window.

.. figure:: /pro/images/gpa/4.png
:alt: img4
.. figure:: /pro/images/gpa/4.png
:alt: img4

6. Choose and enter your own PIN with a minimum length of six characters. This PIN is required for the daily usage of the Nitrokey.

.. figure:: /pro/images/gpa/5.png
:alt: img5
.. figure:: /pro/images/gpa/5.png
:alt: img5

7. Go back to the Card Manager window in step three. This time you choose the third button Change PIN in order to change the admin PIN. The admin PIN is required to change the information on the Nitrokey and to change the cryptographic keys. Proceed as described in steps four and five.

8. After changing both the user and the admin PIN, you are back in the Card Manager window. Select "Generate key" in the "Card" menu.

.. figure:: /pro/images/gpa/6.png
:alt: img6
.. figure:: /pro/images/gpa/6.png
:alt: img6

9. Enter your name and e-mail address. You should keep "backup" enabled in order to create a backup file of your cryptographic keys. Optionally you might select an expiration date for your cryptographic keys.

.. figure:: /pro/images/gpa/7.png
:alt: img7
.. figure:: /pro/images/gpa/7.png
:alt: img7

10. Wait until the keys are generated successfully.

.. figure:: /pro/images/gpa/8.png
:alt: img8
.. figure:: /pro/images/gpa/8.png
:alt: img8

11. Enter a strong passphrase for your backup keys. We strongly recommend to store the backup file on a separate storage(e.g. CD-ROM) and on a safe location.

.. figure:: /pro/images/gpa/9.png
:alt: img9
.. figure:: /pro/images/gpa/9.png
:alt: img9

Congratulations, your Nitrokey is now ready to use. Please see the `applications <https://www.nitrokey.com/documentation/applications>`__ section for further information of its usage.
Loading
Loading