michaing / dietpi-docs Goto Github PK

Is it possible to execute the spell check before the link check runs?
Due to the long runtime of the link check I would be able to correct markdown issues as well as spell check issues during the time consuming run of the link check.

Add items about

• Let's Encrypt: https://github.com/MichaIng/DietPi/wiki/Let's-Encrypt---Certbot
• TLS-SSL: https://github.com/MichaIng/DietPi/wiki/TLS-SSL
• Security recommendations: https://github.com/MichaIng/DietPi/wiki/Security-recommendation
• Fail2Ban: https://dietpi.com/phpbb/viewtopic.php?p=452#p452
• Backup/Restoring / Synching
• Updating
• Logfile viewing
• Disk space monitoring

• BruteFIR
• Spotify Connect Web
• Raspotify

FuguHub: Lightweight WebDAV cloud (eg: dropbox) with a CMS (only in dietpi-software).

Prerequisite: Results of issue #238.

PR: MichaIng/DietPi#3894
Forum docs: https://dietpi.com/phpbb/viewtopic.php?p=28903#p28903
+ How to add the self-signed certificate to the OS' Trusted Root Certification Authorities store.

With DietPi guest tools installed, VBoxService runs as time sync daemon to sync time with the host machine. In such case, systemd-timesyncd (which is invoked by DietPi's config option) wont start and hence should be disabled:
dietpi-config > Advanced Options > Time sync mode > Custom.

RPi3b+, latest DietPi, fresh OS install.

If you mount a drive using dietpi-drive_manager as a menu choice, then the speed test benchmarks you can only do on samba mounts. On NFS mounts error message when attempting benchmarking is "(stand in) syntax error)" and it returns to a results screen without numbers.

I really appreciate the ability to mount drives so early in a new OS install, and the easy low key way it's done. My first thought when setting up my first Raspberry Pi was how could I use its various software to access files stored on my NAS, and I anticipated complex Linux command line and editing important system files - it was such a relief to have it done for you, and so easily, in DietPi.

Some places in DietPi documentation it is erronously stated that you need to install FTP/Samba/NFS file servers for certain functionality, such as providing media file locations for media center software. The server softwares are only needed if you need to access the RPi from something else. The client software, for accessing other stuff from the RPi, either comes preinstalled or is installed when mounting in drive_manager, I am not sure which.

Extend the current section, and turn it into "Web development".

This will include next sections:

• web development stacks, including a more extended spec of SSL support (using Let's encrypt)
• individual web servers
• individual databases and data stores

For each stack user will have the option to install & use the default configuration, as well as install individual elements of the stack.

Currently when accessing https://dietpi.com/docs/user-guide_installation/, the SBC install steps are shown, which is perfectly fine.

However, it would be nice it there was a way to have the UEFI or VirtualBox instructions opened, e.g. via #something or query string.

There are even individual page links for the separate tabs "Introducion" header, #introduction_1 and #introduction_2, but appending those to the URL does not switch the tab: https://dietpi.com/docs/user-guide_installation/#introduction_2

This is basically the downside of having the instructions merged into a single HTML page, but the much cleaner navigation and seamless switch between instructions was totally worth it, IMO 😃.

Although the way to achieve is likely different, the same would be awesome for our download page: To have a single SBC description opened and scrolled to. This is the first thing I'll take care of, as I know the code and should be pretty easy by parsing page link or query string from URL in JavaScript. I'll then also add a possibility to have the SBC brand/type mixer showing a certain subset directly. Both are JavaScript functions which are initialised in a certain way with "All" and "Hidden" but can be simply initialised a different way.

See http://localhost:8000/software/programming/#python-high-level-interpreted-programming-language.
The Python description needs to be extended (e.g. logging, installation directory,...).

The original chapter part to be generated was called:
Python 3 & Flask - Micro web framework powered by Python

Unbound: https://dietpi.com/phpbb/viewtopic.php?p=28779#p28779

Idea:

• Divide the description into sections about webservers, about data bases and about PHP.

Prior to this issue, issues #230 and #231 have to be solved.

• Next steps: Discuss how to implement point above and decide further steps

Section Webservers: Exchange the three bullets with the description "behind the links" (Webserver Preference System):

• Remove the links, but keep the three bullets
• Port the description Webserver Preference System to this section

Probably the social icons at the bottom of the page can be (additionally) made larger.

FuguHub: Lightweight WebDAV cloud (eg: dropbox) with a CMS (only in dietpi-software).

Result of test will be used in issue #239.

PR: MichaIng/DietPi#3933

Need to add Portainer docs before 6.34 release 😉

• Include screenshot from web UI

Add an own chapter for programming languages.
The following programming languages shall be added:

• Go (golang)
• Java
• Python3 / pip3 (moved from "Web Development")
• .NET Core
• Mono
• Docker
• node.js (-> Web Development)

Todo

• Step 1: Add Substructure "Development & Programming"
• Step 2: Move Python to there
• Step 3: Move Docker to there

• Describe fail2ban usage unter "external access".
  See: https://docs.gitea.io/en-us/fail2ban-setup/

Alternative:

• Add a general hardening with https: description in the webserver section (where in detail?).
  See also there: https://github.com/MichaIng/DietPi/wiki/Security-recommendation.
• Reference this hardening section from the software titles and add there specialities of the software title hardening

File system_security.md.

Due to several manual selectable programming language it has to be checked, which packages reside in the actual "Additional Software" and whether they shall reside there.

In https://dietpi.com/dietpi-software.html are icons of software titles as tiles displayed.
This should be consistent to our optimized software list.

Proposal: Vor every software title one tile. Add tiles to dietpi-software.html.

Next steps:

• Step 1: Make a first proposal (align with Download area with the tiles there)

Detail dietpi.txt options. There are multiple options, including the option to automatically install a set of software titles on first boot.

See https://dietpi.com/phpbb/viewtopic.php?p=23065#p23065.

File remote_desktop.md.

Creating a bug report/issue

Required Information

• DietPi version | cat /DietPi/dietpi/.version
  G_DIETPI_VERSION_CORE=6
  G_DIETPI_VERSION_SUB=25
  G_DIETPI_VERSION_RC=3
  G_GITBRANCH='master'
  G_GITOWNER='MichaIng'

• Distro version | echo $G_DISTRO_NAME or cat /etc/debian_version
  stretchcat /etc/debian_version

• Kernel version | uname -a
Linux SubsonicHome 4.19.42-v7+ MichaIng/DietPi#1219 SMP Tue May 14 21:20:58 BST 2019 armv7l GNU/Linux

• SBC device | echo $G_HW_MODEL_DESCRIPTION or (EG: RPi3)
  RPi 3 Model B+ (armv7l)

• Power supply used | (EG: 5V 1A RAVpower)
  pi store brand - 5v 1amp

• SDcard used | (EG: SanDisk ultra)
  Sandisk extreme

Additional Information (if applicable)

• Software title | Subsonic
• Was the software title installed freshly or updated/migrated? Installed in January
• Can this issue be replicated on a fresh installation of DietPi? Yes

• Bug report ID | sed -n 5p /DietPi/dietpi/.hw_model

Steps to reproduce

1. ... Install and configure subsonic. No special setup. Audio and server work flawless once music shares are added and scanned. When playing music from an app like Play:sub and selecting jukebox mode, which should output sound on the pi3, there is no sound.
2. ...

Expected behaviour

• ...

Actual behaviour

• ...

Extra details

sound works on the pi using aplay and testing a wave file. No issues. The jukebox mode is the only issue. I've also tested hifiberry dac and get the same results. System sound with aplay works but Subsonic won't output sound.

The issue seems related to Java sound settings. See the link below. Seems the java settings in the subsonic settings does not use the correct audio device. I would test further but I'm unable to get an accurate list of java audio devices in the format "NVidia [plughw:0,3]" for example. This seems to be at the root of the issue and I don't know if that is an issue that can be solved by the underlying os or if it's simply a Subsonic issue.
http://forum.subsonic.org/forum/viewtop ... java+sound

• ...

Let's Encrypt / CertBot shall be moved from Web Development chapter to System Security chapter.
In the System Security chapter there is also Fail2Ban located.

Let's Encrpyt move to "System Security" and reference it at further positions like "Web Development", "gitea", "nextcloud", etc.

• Next step: Move and introduce Certbot to System Security.

There: http://localhost:8000/software/cloud/#gitea-github-style-server-with-web-interface.

ADMIN EDIT

Some SBCs have an SPI flash to contain the bootloader, and if it is present, they won't use the bootloader of the root drive. This can cause a mismatch between the SPI flash bootloader and the boot configs and kernel from our image, so booting fails. We have zero chance to fix this our end, but users need to be aware of it and erase the SPI flash before the DietPi image can boot. I'm not sure how to do that externally, e.g. if there is no functional system present anymore, but doing it from a booted system is relatively easy with the script/command described below. Depending on the exact SBC there may be also ways to force it ignoring the SPI flash.

On RPi 4 it's btw the same, with its EEPROM bootloader which may cause issues when the OS is prepared to be booted differently.

Creating a bug report/issue
Required Information

DietPi version |
Distro version | Buster
Kernel version |
SBC device | ROCKPi4-ARMv8 4GB
Power supply used | 5V 3A
SDcard used | SanDisk ultra 64GB

Additional Information

I cant boot up after a fresh flash to the SD-card
I used Rufus, Win32DiskImager, and Etcher
I dont get a picture when i connect the device to a monitor via HDMI (not with an adapter)
I dont see the device in my router when its connected to my LAN
Steps to reproduce

Flash rockpi4-debian-stretch-desktop on SD-card. Boot up and apt-get update && apt-get upgrade
(i dont know if this is the problem:) Type "y" at the question:

"Step one: upgrade bootloader on SPI Flash
One boot device, SPI Flash, is found, would you like to upgrade bootloader on it?
The installation would cost about seven minutes."

shut down the device

take out SD
flash Dietpi from https://dietpi.com/ to Sd
put it back and nothing works
Expected behaviour

Dietpi should boot up and show up in my router or show something on my monitor
Actual behaviour

The green LED lights up constantly
no picture on monitor, not showing up in router.
Extra details

It worked a few days ago. Then i used rockpi4-debian-stretch-desktop with the SD-card booted up and upgradet the bootloader on SPI Flash. I reflashed Dietpi, nothing works now.

I still can Flash rockpi4-debian-stretch-desktop and it will boot up, but dietpi wont.

I finally did it after going all the wrong ways.

The easiest way is to delete the SPI-bootloader with the Debian you upgraded it with:

• 1. boot debian (i used "rockpi4-debian-stretch-desktop-arm64-20190730_2022-gpt")

[not mandatory]

• 2. sudo apt-get update
• 3. sudo apt-get upgrade
• 4. dont upgrade spi-bootloader, or do it, doesn't really matter

• 5. cd /usr/local/sbin/
• 6. sudo ./rockpi4b_erase_spi_flash.sh
• 7. type YES

And now you can "burn" a DietPi.img to an SD as usual and boot it.

However, I cannot say how it behaves with other storage media and hard disk partitioning. I will have to try this in the future.

There: https://dietpi.com/dietpi-software.html

Idea: Add a link to the "new" documentation software pages from the tiles.
Rename the basic text for this linking to "Once installed" -> "Further information".

Start with one tile and then review for further decision.

• Next step: Continue to work and discuss on this topic

From here to here.

File system_stats.md.

I propose that we announce docu porting at this place in advance to the beginning of the work. I.e. here someone gets an overview who is working on which parts.

After the pull request is finished (reviewed, merged), the issue will be closed by the issue author to signal that his work is finished for now.

This behaves like a semaphore handling. :-)

@MichaIng, @fpetru: What do you think?

Relate to at https://github.com/MichaIng/DietPi/blob/dev/dietpi/dietpi-software.

Porting started.

Redis actually only in dietpi-software present.

See https://dietpi.com/phpbb/viewtopic.php?p=20584#p20584.

• via dietpi-backup (https://dietpi.com/docs/dietpi_tools/#update-backup)
• via different/other backup solutions. E.g. see
  • https://www.linuxlinks.com/backup/

Additional idea:

• Add timeshift as an additional software title
• Use also timeshift and have a directory converter for the backup/restore file structure

Additional options:

• restic: https://restic.net/
• DejaDup: https://wiki.gnome.org/Apps/DejaDup
• Use backup with anacron instead of cron (https://www.thomas-krenn.com/de/wiki/Anacron, https://en.wikipedia.org/wiki/Anacron, https://linoxide.com/linux-how-to/schedule-job-linux-commands/, https://www.tecmint.com/cron-vs-anacron-schedule-jobs-using-anacron-on-linux/)

Further information:

• Search also in the DietPi Forum for "best practices" (https://dietpi.com/phpbb/search.php?keywords=%22dietpi-backup%22)
• See also https://ostechnix.com/how-to-backup-and-restore-linux-system-with-timeshift/
• https://www.linuxlinks.com/backup/
• https://www.tecmint.com/linux-system-backup-tools/

Further ToDos

• Describe command line options of dietpi-backup
• Describe how to diagnose the backup result (e.g. logfile)
• Describe the boot restore option via /boot/dietpi.txt -> UTO_SETUP_BACKUP_RESTORE=0

Goals:

• Improve short description of backup/restore within the DietPi tools doc section
• Add a howto page
• Add it in the Blog

pymdown extensions have been updated: https://github.com/facelessuser/pymdown-extensions/releases/tag/8.1

NEW: Tabbed titles can now have simple Markdown in them which can be parsed and rendered (like emoji, bold, etc.).

This means we can do something like:

=== "Tab with **fat** word inside 👍"

In reference to MichaIng/DietPi#3835 (comment), a troubleshooting guide with common issues and fixes should be added to the docs.

The link checker via peter-evans/link-checker throws a couple of errors which could be overcome by optimizing the file .github/workflows/actions.yml:

• Exclude from link check via command line "-r <regex>"
  • http://localhost
  • http://192.168.0.100
• Exclude file build/docs/release-notes.md and dietpi_docs_todo.md from getting link checked
  • possibly via any command line option (don't know how)
  • moving these two files from the directory build/docs (this would also help for the Markdown check)

See also section "Check links in html files", error output of one of the pull request action logs.

Java Runtime Environment JRE: ID 196
Java Development Kit JDK: ID 8
Mono: ID 150

To shorten/simplify links to the individual software title docs.

See there: https://dietpi.com/docs/dietpi-software-webserver-stack/

Add a section how to select the webservers stacks via dietpi-software. Two options: Select via Software Optimized or via Webserver Preference (Preference is used in the case of the first webserver background installation).

MichaIng/DietPi#3960

• Add links from the changelog key words to the related doc pages

Currently both docs are independent and Unbound docs are very minimal and do not really explain the idea behind it and why it is offered together with Pi-hole installs.

A third combined documentation could be added below them to explain, at best via nice picture, how DNS requests are usually done, which actors are involved and who can read them, how things change with Unbound and how with Unbound + DoT (DNS over TLS).

Additionally we need to add a tab to the Unbound documentation about how to enabled DoT, which again requires an upstream DNS provider but sends DNS requests encrypted so that a local ISP cannot read them.

See https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&p=26255&hilit=jellyfin#p26255.
Package is not described there: http://localhost:8000/dietpi_optimised_software/#media-systems.