From 3d00eff29fe221b9380113c85a1e91bddecd782c Mon Sep 17 00:00:00 2001 From: StephanStS <57687516+StephanStS@users.noreply.github.com> Date: Wed, 7 Oct 2020 12:01:09 +0200 Subject: [PATCH 01/14] Create DietPi-Docs_Todo.md --- DietPi-Docs_Todo.md | 109 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 109 insertions(+) create mode 100644 DietPi-Docs_Todo.md diff --git a/DietPi-Docs_Todo.md b/DietPi-Docs_Todo.md new file mode 100644 index 000000000..f781229be --- /dev/null +++ b/DietPi-Docs_Todo.md @@ -0,0 +1,109 @@ +# DietPi-Docs Ideas + + +## 1. Development general + +### 1.1 Branching +1. Q: Shall we use (personal) branches to push changes directly into the master branch, or shall we use forking mechanisms? +2. If using branches, which naming conventions shall we use for branch names (e.g. "dev--". Example: "dev-StS-AddBoardImages" or "dev-MiI-DescribeWebserverStacks") + + + +## 2. Files general + +### 2.1 Filenames .md +Some of the filenames use '-', others use '_'. +E.g. dietpi-software-bittorrent.md vs. user-guide_install.md. +I would prefer the latter one: _.md. + +### 2.2 File structure +Q: Shall we structure every chapter to subdirs (with own assets sub-subdirs)? +This could lead to a more general structure if the docu is extending. + +Could this lead to problems when chapters or images are used several times? + + + +## 3. Installation chapter +### 3.1 Docu structure +Today: +- Installation (*covers SBC installation* and *First boot on DietPi*) +- Advanced installation + - Install DietPi on native PC + - Install DietPi as an Oracle VirtualBox machine + +Proposal: +- **Installation** (*covers overview over several options: SBC, PC, virtual machine*) + - **Installation on SBC** ([contents](https://dietpi.com/docs/user-guide_install/)) + - **Installation on native PC** ([contents](https://dietpi.com/docs/user-guide_install_uefi/)) + - **Installation on VirtualBox machine** ([contents](https://dietpi.com/docs/user-guide_install_VirtualBox/)) + - (later: - **Installation on VmWare virtual machine**) + - **First boot on DietPi** (move this from the [*Installation on SBC*](https://dietpi.com/docs/user-guide_install/#3-first-boot-on-dietpi) section to here) + + +### 3.2 Description of *dietpi-software* usage +1. Move [4. Install software with the DietPi-Software tool](https://dietpi.com/docs/user-guide_install/#4-install-software-with-the-dietpi-software-tool) to [DietPi Optimised software Index](https://dietpi.com/docs/user-optimised-software/) ? + *dietpi-software* should not be a tool which is run only once during the installation. + + +## 4 Supported Single Board Computers (SBCs) +See there: https://dietpi.com/docs/hardware-supported_sbc/. + +### 4.1 Structure of chapters +Harmonize/rearrange order in all sub-chapters: +- Heading +- Hardware description +- Picture of hardware +- Link table to images + + + +### 4.2 Supported Single Board Computers (SBCs) +1. Move *NanoPi Series (FriendlyARM)* below *ASUS Tinker Board* + + +### 4.3 Description of DietPi PREP? +1. Q: Shall we describe this issue in a comprehensive form? + Possibly this will lead to too much questions? + +Actually it is only referenced at the end of the [*Supported SBC* section](https://dietpi.com/docs/hardware-supported_sbc/#make-your-own-distribution). + + +### 4.4 Name of .md file +1. Q: Rename *hardware-supported_sbc.md* to *user-guide_supported_sbc.md* + + +### 4.5 Images +Add images for +- Firefly +- Sparky SBC (Allo) + +The images are available on Dietpi.com\Download. + + +## 5. Desktops +Desktop basics (https://dietpi.com/docs/dietpi-software-desktop/): +1. Add a section how to setup the ***Autostart options*** via ***dietpi-config*** to start with LightDM + - Have it similar to the collapsable description *How do I run DietPi-Software and install Optimised software ?* + + +LXQt (https://dietpi.com/docs/dietpi-software-desktop/#lxqt-optimized-lightweight-desktop): +1. Add screenshot of desktop + + +## 6. DietPi Tools +See there: https://dietpi.com/docs/user-guide_tools/ +1. Add a screenshot for *Software Additional* + + +## 7. Description of Webserver stacks +See there: https://dietpi.com/docs/dietpi-software-webserver-stack/ +1. Add a section how to select the webservers stacks via ***dietpi-software*** +2. Section [Webservers](https://dietpi.com/docs/dietpi-software-webserver-stack/#webservers): Exchange the three bullets with the description "behind the links" ([*Webserver Preference System*](https://dietpi.com/phpbb/viewtopic.php?p=1549#p1549)) + + + +## 8. Links *Return to the Optimised Software list* +See there: https://dietpi.com/docs/dietpi-software-webserver-stack/ +At the bottom there is a link to jump back. +Q: Is this linking done in all necessary pages? If no, where should it be inserted? From 46fef2b3d131a9ea5ace4b977533867cd3d73256 Mon Sep 17 00:00:00 2001 From: MichaIng Date: Thu, 8 Oct 2020 20:24:27 +0200 Subject: [PATCH 02/14] Shorten URLs --- docs/dietpi-software-log-system.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/dietpi-software-log-system.md b/docs/dietpi-software-log-system.md index 49ca98503..0ea1ec8a6 100644 --- a/docs/dietpi-software-log-system.md +++ b/docs/dietpi-software-log-system.md @@ -6,8 +6,7 @@ The links redirect to the old documentation available on [DietPi.com Forum](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5). **We need your help to create and update this documentation ! Thank you** :octicons-heart-16: :octicons-heart-16: -- [DietPi-RAMlog - Lightweight RAM logging.](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=20#p68) -- [Full - Full logging system with Rsyslog and Logrotate.](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=20#p68) +- [DietPi-RAMlog - Lightweight RAM logging.](https://dietpi.com/phpbb/viewtopic.php?p=68#p68) +- [Full - Full logging system with Rsyslog and Logrotate.](https://dietpi.com/phpbb/viewtopic.php?p=68#p68) [Return to the **Optimised Software list**](../user-optimised-software) - From dfa1fe82d4eee4bc1e6e3fbe1e34c4bbe3be1b1a Mon Sep 17 00:00:00 2001 From: StephanStS Date: Fri, 9 Oct 2020 09:33:58 +0200 Subject: [PATCH 03/14] Update DietPi-Docs_Todo.md --- DietPi-Docs_Todo.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/DietPi-Docs_Todo.md b/DietPi-Docs_Todo.md index f781229be..7dcacc734 100644 --- a/DietPi-Docs_Todo.md +++ b/DietPi-Docs_Todo.md @@ -107,3 +107,9 @@ See there: https://dietpi.com/docs/dietpi-software-webserver-stack/ See there: https://dietpi.com/docs/dietpi-software-webserver-stack/ At the bottom there is a link to jump back. Q: Is this linking done in all necessary pages? If no, where should it be inserted? + + +## 9. Gitea software +Describe fail2ban usage unter "external access". +See: https://docs.gitea.io/en-us/fail2ban-setup/ + From 51b351517f631bd7937f2a5c6a789ee120ff862a Mon Sep 17 00:00:00 2001 From: StephanStS Date: Fri, 9 Oct 2020 09:58:02 +0200 Subject: [PATCH 04/14] Update DietPi-Docs_Todo.md --- DietPi-Docs_Todo.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/DietPi-Docs_Todo.md b/DietPi-Docs_Todo.md index 7dcacc734..29b335f41 100644 --- a/DietPi-Docs_Todo.md +++ b/DietPi-Docs_Todo.md @@ -110,6 +110,12 @@ Q: Is this linking done in all necessary pages? If no, where should it be insert ## 9. Gitea software -Describe fail2ban usage unter "external access". -See: https://docs.gitea.io/en-us/fail2ban-setup/ +### 9.1 Prerequisites +Describe/check user rights of dietpi user and letsencrypt. + +### 9.2 Add section "hardening Gitea for external access (behind a router)" +- Describe fail2ban usage unter "external access". + See: https://docs.gitea.io/en-us/fail2ban-setup/ +- Describe combination Gitea and letsencrypt. Then use https for access. + From 079251cb5a46630589d058ebbca8902e4f442139 Mon Sep 17 00:00:00 2001 From: StephanStS <57687516+StephanStS@users.noreply.github.com> Date: Fri, 9 Oct 2020 09:59:36 +0200 Subject: [PATCH 05/14] Update DietPi-Docs_Todo.md --- DietPi-Docs_Todo.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/DietPi-Docs_Todo.md b/DietPi-Docs_Todo.md index f781229be..68cc9a91b 100644 --- a/DietPi-Docs_Todo.md +++ b/DietPi-Docs_Todo.md @@ -7,6 +7,15 @@ 1. Q: Shall we use (personal) branches to push changes directly into the master branch, or shall we use forking mechanisms? 2. If using branches, which naming conventions shall we use for branch names (e.g. "dev--". Example: "dev-StS-AddBoardImages" or "dev-MiI-DescribeWebserverStacks") +Have branches on MichaIng/DietPi-Docs: +- master branch: stable +- dev branch: work on this branch and will be merged into master branch at planned release dates + +Everyone works on his own fork for development. There "private" branches with "private" naming can be chosen. + +Committing changes from the private fork branch to the dev branch on Micha's repo shall be done via a pull request. + +Merging should be done via 4-eyes method when merging to the master branch. ## 2. Files general @@ -16,12 +25,24 @@ Some of the filenames use '-', others use '_'. E.g. dietpi-software-bittorrent.md vs. user-guide_install.md. I would prefer the latter one: _.md. +Style Guide: _.md, e.g. user-guide_install.md. +ToDo: Change file names initially. +Remark: Google search should be considered. + +**ToDo: Petru** + + ### 2.2 File structure Q: Shall we structure every chapter to subdirs (with own assets sub-subdirs)? This could lead to a more general structure if the docu is extending. Could this lead to problems when chapters or images are used several times? +Open point, has to be cleared. + +**ToDo: Petru** + + ## 3. Installation chapter @@ -41,10 +62,23 @@ Proposal: - **First boot on DietPi** (move this from the [*Installation on SBC*](https://dietpi.com/docs/user-guide_install/#3-first-boot-on-dietpi) section to here) +Idea: Use tabs in the content area (like there: https://dietpi.com/docs/dietpi-software-desktop/#lxde-ultra-lightweight-desktop) to distinguish between SBC, native PC, VirtualBox,etc. +Below the tab area the *First boot on DietPi* section is located. + +**ToDo Stephan:** Implement the changed *Installation* structure. + + + ### 3.2 Description of *dietpi-software* usage 1. Move [4. Install software with the DietPi-Software tool](https://dietpi.com/docs/user-guide_install/#4-install-software-with-the-dietpi-software-tool) to [DietPi Optimised software Index](https://dietpi.com/docs/user-optimised-software/) ? *dietpi-software* should not be a tool which is run only once during the installation. +Shall be moved to *Getting started*. + +*Getting started* shall contain often used procedures. Seldom used procedures shall be in *Advanced configuration & DietPi tools*. + + +# xxx go ahead here ## 4 Supported Single Board Computers (SBCs) See there: https://dietpi.com/docs/hardware-supported_sbc/. From 77bd9a1fe4f96767ba6b8d9094ad2ac1dc6337fd Mon Sep 17 00:00:00 2001 From: fpetru Date: Fri, 9 Oct 2020 20:43:11 +0200 Subject: [PATCH 06/14] enable file naming rules --- ...rrent.md => dietpi-software_bittorrent.md} | 2 +- ...re-camera.md => dietpi-software_camera.md} | 2 +- ...ware-cloud.md => dietpi-software_cloud.md} | 2 +- ... dietpi-software_computational_science.md} | 2 +- ...-desktop.md => dietpi-software_desktop.md} | 2 +- ...vers.md => dietpi-software_dns_servers.md} | 2 +- ...ers.md => dietpi-software_file_servers.md} | 2 +- ...re-gaming.md => dietpi-software_gaming.md} | 3 +- ...d => dietpi-software_hardware_projects.md} | 2 +- ....md => dietpi-software_home_automation.md} | 2 +- ...er.md => dietpi-software_load_balancer.md} | 2 +- ...ystem.md => dietpi-software_log_system.md} | 2 +- ...ware-media.md => dietpi-software_media.md} | 2 +- ...rinting.md => dietpi-software_printing.md} | 2 +- ...p.md => dietpi-software_remote_desktop.md} | 2 +- ...re-social.md => dietpi-software_social.md} | 2 +- ...software-ssh.md => dietpi-software_ssh.md} | 2 +- ....md => dietpi-software_system_security.md} | 2 +- ...ats.md => dietpi-software_system_stats.md} | 2 +- ...software-vpn.md => dietpi-software_vpn.md} | 2 +- ....md => dietpi-software_webserver_stack.md} | 2 +- ...pot.md => dietpi-software_wifi_hotspot.md} | 2 +- ...ftware.md => dietpi_optimised_software.md} | 0 ...ardware-supported_sbc.md => dietpi_sbc.md} | 2 +- docs/{user-guide_tools.md => dietpi_tools.md} | 0 docs/index.md | 6 +- ...ease-notes-updates.md => release-notes.md} | 0 docs/user-guide_install_VirtualBox.md | 2 +- ...e_install.md => user-guide_install_sbc.md} | 2 +- docs/user-guide_install_uefi.md | 2 +- docs/user-guide_overview.md | 6 +- mkdocs.yml | 92 +++++++++++++------ requirements.txt | 1 + 33 files changed, 97 insertions(+), 61 deletions(-) rename docs/{dietpi-software-bittorrent.md => dietpi-software_bittorrent.md} (97%) rename docs/{dietpi-software-camera.md => dietpi-software_camera.md} (88%) rename docs/{dietpi-software-cloud.md => dietpi-software_cloud.md} (98%) rename docs/{dietpi-software-computational-science.md => dietpi-software_computational_science.md} (86%) rename docs/{dietpi-software-desktop.md => dietpi-software_desktop.md} (98%) rename docs/{dietpi-software-dns-servers.md => dietpi-software_dns_servers.md} (88%) rename docs/{dietpi-software-file-servers.md => dietpi-software_file_servers.md} (90%) rename docs/{dietpi-software-gaming.md => dietpi-software_gaming.md} (93%) rename docs/{dietpi-software-hardware-projects.md => dietpi-software_hardware_projects.md} (96%) rename docs/{dietpi-software-home-automation.md => dietpi-software_home_automation.md} (90%) rename docs/{dietpi-software-load-balancer.md => dietpi-software_load_balancer.md} (85%) rename docs/{dietpi-software-log-system.md => dietpi-software_log_system.md} (88%) rename docs/{dietpi-software-media.md => dietpi-software_media.md} (97%) rename docs/{dietpi-software-printing.md => dietpi-software_printing.md} (88%) rename docs/{dietpi-software-remote-desktop.md => dietpi-software_remote_desktop.md} (98%) rename docs/{dietpi-software-social.md => dietpi-software_social.md} (93%) rename docs/{dietpi-software-ssh.md => dietpi-software_ssh.md} (88%) rename docs/{dietpi-software-system-security.md => dietpi-software_system_security.md} (88%) rename docs/{dietpi-software-system-stats.md => dietpi-software_system_stats.md} (93%) rename docs/{dietpi-software-vpn.md => dietpi-software_vpn.md} (91%) rename docs/{dietpi-software-webserver-stack.md => dietpi-software_webserver_stack.md} (95%) rename docs/{dietpi-software-wifi-hotspot.md => dietpi-software_wifi_hotspot.md} (88%) rename docs/{user-optimised-software.md => dietpi_optimised_software.md} (100%) rename docs/{hardware-supported_sbc.md => dietpi_sbc.md} (99%) rename docs/{user-guide_tools.md => dietpi_tools.md} (100%) rename docs/{release-notes-updates.md => release-notes.md} (100%) rename docs/{user-guide_install.md => user-guide_install_sbc.md} (99%) diff --git a/docs/dietpi-software-bittorrent.md b/docs/dietpi-software_bittorrent.md similarity index 97% rename from docs/dietpi-software-bittorrent.md rename to docs/dietpi-software_bittorrent.md index bdf9e1867..9c3449794 100644 --- a/docs/dietpi-software-bittorrent.md +++ b/docs/dietpi-software_bittorrent.md @@ -22,7 +22,7 @@ - [NZBget - NZB download manager with web interface.](https://dietpi.com/phpbb/viewtopic.php?p=7575#p7575) - [HTPC Manager - combines all your favourite software into one slick interface.](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=110#p8043) -[Return to the **Optimised Software list**](../user-optimised-software) +[Return to the **Optimised Software list**](../dietpi_optimised_software) ## Bazarr diff --git a/docs/dietpi-software-camera.md b/docs/dietpi-software_camera.md similarity index 88% rename from docs/dietpi-software-camera.md rename to docs/dietpi-software_camera.md index d2f9a380c..6cdc0c66b 100644 --- a/docs/dietpi-software-camera.md +++ b/docs/dietpi-software_camera.md @@ -9,4 +9,4 @@ - [RPi Cam Control - RPi Camera / Web Interface Surveillance](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5#p48) - [MotionEye - Camera / Web Interface Surveillance](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=100#p6610) -[Return to the **Optimised Software list**](../user-optimised-software) +[Return to the **Optimised Software list**](../dietpi_optimised_software) diff --git a/docs/dietpi-software-cloud.md b/docs/dietpi-software_cloud.md similarity index 98% rename from docs/dietpi-software-cloud.md rename to docs/dietpi-software_cloud.md index f296176ea..bf637ec19 100644 --- a/docs/dietpi-software-cloud.md +++ b/docs/dietpi-software_cloud.md @@ -18,7 +18,7 @@ - [Minio - S3 compatible distributed object server](https://dietpi.com/phpbb/viewtopic.php?p=9121#p9121) - [Firefox Sync Server - Sync bookmarks, tabs, history & passwords](https://dietpi.com/phpbb/viewtopic.php?p=24713#p24713) -[Return to the **Optimised Software list**](../user-optimised-software) +[Return to the **Optimised Software list**](../dietpi_optimised_software) ??? info "How do I run **DietPi-Software** and install **Optimised software** ?" To install any of the **DietPi Optimised Software** listed below run from the command line: diff --git a/docs/dietpi-software-computational-science.md b/docs/dietpi-software_computational_science.md similarity index 86% rename from docs/dietpi-software-computational-science.md rename to docs/dietpi-software_computational_science.md index 51614f912..cad0b9081 100644 --- a/docs/dietpi-software-computational-science.md +++ b/docs/dietpi-software_computational_science.md @@ -8,5 +8,5 @@ - [Folding@Home - Use processing power to assist with disease research](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=130#p13704) -[Return to the **Optimised Software list**](../user-optimised-software) +[Return to the **Optimised Software list**](../dietpi_optimised_software) diff --git a/docs/dietpi-software-desktop.md b/docs/dietpi-software_desktop.md similarity index 98% rename from docs/dietpi-software-desktop.md rename to docs/dietpi-software_desktop.md index 099c5aa48..1aade6200 100644 --- a/docs/dietpi-software-desktop.md +++ b/docs/dietpi-software_desktop.md @@ -17,7 +17,7 @@ - [QuiteRSS - RSS and Atom news feeds reader](#quiterss-atom-news-feeds-reader) - [Xfce4 Power - Power manager with brightness](#xfce4-power-power-manager-with-brightness) -[Return to the **Optimised Software list**](../user-optimised-software) +[Return to the **Optimised Software list**](../dietpi_optimised_software) ??? info "How do I run **DietPi-Software** and install **Optimised software** ?" To install any of the **DietPi Optimised Software** listed below run from the command line: diff --git a/docs/dietpi-software-dns-servers.md b/docs/dietpi-software_dns_servers.md similarity index 88% rename from docs/dietpi-software-dns-servers.md rename to docs/dietpi-software_dns_servers.md index da7e74f9c..993f50869 100644 --- a/docs/dietpi-software-dns-servers.md +++ b/docs/dietpi-software_dns_servers.md @@ -12,4 +12,4 @@ - [No-IP - Website URL Address](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=10#p58) -[Return to the **Optimised Software list**](../user-optimised-software) +[Return to the **Optimised Software list**](../dietpi_optimised_software) diff --git a/docs/dietpi-software-file-servers.md b/docs/dietpi-software_file_servers.md similarity index 90% rename from docs/dietpi-software-file-servers.md rename to docs/dietpi-software_file_servers.md index 157a3928f..b8f45dd5a 100644 --- a/docs/dietpi-software-file-servers.md +++ b/docs/dietpi-software_file_servers.md @@ -11,4 +11,4 @@ - [vsFTPD - Feature rich FTP file server.](https://dietpi.com/phpbb/viewtopic.php?p=2820#p2820) - [NFS - Network file system server](https://dietpi.com/phpbb/viewtopic.php?p=2821#p2821) -[Return to the **Optimised Software list**](../user-optimised-software) +[Return to the **Optimised Software list**](../dietpi_optimised_software) diff --git a/docs/dietpi-software-gaming.md b/docs/dietpi-software_gaming.md similarity index 93% rename from docs/dietpi-software-gaming.md rename to docs/dietpi-software_gaming.md index dd899c79f..13d01fb47 100644 --- a/docs/dietpi-software-gaming.md +++ b/docs/dietpi-software_gaming.md @@ -14,4 +14,5 @@ - [DXX-Rebirth - Descent 1 & 2 OpenGL port](https://dietpi.com/phpbb/viewtopic.php?p=2963#p2963) - [Steam - Steam client](https://dietpi.com/phpbb/viewtopic.php?p=8016#p8016) -[Return to the **Optimised Software list**](../user-optimised-software) +[Return to the **Optimised Software list**](../dietpi_optimised_software) + diff --git a/docs/dietpi-software-hardware-projects.md b/docs/dietpi-software_hardware_projects.md similarity index 96% rename from docs/dietpi-software-hardware-projects.md rename to docs/dietpi-software_hardware_projects.md index 9722a2805..5f82dfc3d 100644 --- a/docs/dietpi-software-hardware-projects.md +++ b/docs/dietpi-software_hardware_projects.md @@ -19,4 +19,4 @@ - [InfluxDB - Database optimized to save time based data as logs or data from a sensor.](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=120#p12523) - [Grafana - The open platform for beautiful analytics and monitoring.](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=130#p12524) -[Return to the **Optimised Software list**](../user-optimised-software) +[Return to the **Optimised Software list**](../dietpi_optimised_software) diff --git a/docs/dietpi-software-home-automation.md b/docs/dietpi-software_home_automation.md similarity index 90% rename from docs/dietpi-software-home-automation.md rename to docs/dietpi-software_home_automation.md index f19b874e5..f9bd1cd35 100644 --- a/docs/dietpi-software-home-automation.md +++ b/docs/dietpi-software_home_automation.md @@ -10,4 +10,4 @@ - [EmonPi - Lightweight Energy usage stats with EmonPi PCB.](https://dietpi.com/phpbb/viewtopic.php?p=1529#p1525) - [Grasshopper - Web App to control Bticino MyHome](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=20#p70) -[Return to the **Optimised Software list**](../user-optimised-software) +[Return to the **Optimised Software list**](../dietpi_optimised_software) diff --git a/docs/dietpi-software-load-balancer.md b/docs/dietpi-software_load_balancer.md similarity index 85% rename from docs/dietpi-software-load-balancer.md rename to docs/dietpi-software_load_balancer.md index 85551efab..edc9aa388 100644 --- a/docs/dietpi-software-load-balancer.md +++ b/docs/dietpi-software_load_balancer.md @@ -8,5 +8,5 @@ - [HAProxy - High performance TCP/HTTP load balancer.](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=30#p221) -[Return to the **Optimised Software list**](../user-optimised-software) +[Return to the **Optimised Software list**](../dietpi_optimised_software) diff --git a/docs/dietpi-software-log-system.md b/docs/dietpi-software_log_system.md similarity index 88% rename from docs/dietpi-software-log-system.md rename to docs/dietpi-software_log_system.md index 49ca98503..f255e1562 100644 --- a/docs/dietpi-software-log-system.md +++ b/docs/dietpi-software_log_system.md @@ -9,5 +9,5 @@ - [DietPi-RAMlog - Lightweight RAM logging.](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=20#p68) - [Full - Full logging system with Rsyslog and Logrotate.](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=20#p68) -[Return to the **Optimised Software list**](../user-optimised-software) +[Return to the **Optimised Software list**](../dietpi_optimised_software) diff --git a/docs/dietpi-software-media.md b/docs/dietpi-software_media.md similarity index 97% rename from docs/dietpi-software-media.md rename to docs/dietpi-software_media.md index 1fd05e8df..e6e49791f 100644 --- a/docs/dietpi-software-media.md +++ b/docs/dietpi-software_media.md @@ -34,4 +34,4 @@ - [Ubooquity - Free home server for your comics and ebooks library](https://dietpi.com/phpbb/viewtopic.php?p=12969#p12969) - [Komga - Free and open source comics/mangas media server with web UI](https://dietpi.com/phpbb/viewtopic.php?p=26858#p26858) -[Return to the **Optimised Software list**](../user-optimised-software) +[Return to the **Optimised Software list**](../dietpi_optimised_software) diff --git a/docs/dietpi-software-printing.md b/docs/dietpi-software_printing.md similarity index 88% rename from docs/dietpi-software-printing.md rename to docs/dietpi-software_printing.md index 6d3681188..975d360d7 100644 --- a/docs/dietpi-software-printing.md +++ b/docs/dietpi-software_printing.md @@ -9,4 +9,4 @@ - [CloudPrint - CUPS print server, with support for Google cloud printing](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=100#p6630) - [OctoPrint - Web interface for controlling 3D printers](https://dietpi.com/phpbb/viewtopic.php?p=7958#p7958) -[Return to the **Optimised Software list**](../user-optimised-software) +[Return to the **Optimised Software list**](../dietpi_optimised_software) diff --git a/docs/dietpi-software-remote-desktop.md b/docs/dietpi-software_remote_desktop.md similarity index 98% rename from docs/dietpi-software-remote-desktop.md rename to docs/dietpi-software_remote_desktop.md index 3cd25626e..551ff73b8 100644 --- a/docs/dietpi-software-remote-desktop.md +++ b/docs/dietpi-software_remote_desktop.md @@ -15,7 +15,7 @@ - [Remot3.it - (Weaved) Access your device over the internet.](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=20#p188) - [VirtualHere - Share physically attached USB devices from your SBC, over the network.](https://dietpi.com/phpbb/viewtopic.php?p=6709#p6709) -Return to the full [**Optimised Software**](../user-optimised-software) list. +[Return to the **Optimised Software list**](../dietpi_optimised_software) ??? info "How do I run **DietPi-Software** and install **Optimised software** ?" To install any of the **DietPi Optimised Software** listed below run from the command line: diff --git a/docs/dietpi-software-social.md b/docs/dietpi-software_social.md similarity index 93% rename from docs/dietpi-software-social.md rename to docs/dietpi-software_social.md index 356935d18..3aa03d6a8 100644 --- a/docs/dietpi-software-social.md +++ b/docs/dietpi-software_social.md @@ -14,4 +14,4 @@ - [OpenBazaar - Decentralized peer to peer market server using BitCoin.](https://dietpi.com/phpbb/viewtopic.php?p=1796#p1796) - [YaCy - Decentralized open source search engine.](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=90#p6202) -[Return to the **Optimised Software list**](../user-optimised-software) +[Return to the **Optimised Software list**](../dietpi_optimised_software) diff --git a/docs/dietpi-software-ssh.md b/docs/dietpi-software_ssh.md similarity index 88% rename from docs/dietpi-software-ssh.md rename to docs/dietpi-software_ssh.md index 95e4b3e01..a7d76b4a8 100644 --- a/docs/dietpi-software-ssh.md +++ b/docs/dietpi-software_ssh.md @@ -5,7 +5,7 @@ - [Dropbear - Lightweight SSH Server](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=10#p62) - [OpenSSH - Feature rich SSH server with SFTP/SCP support.](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=10#p63) -[Return to the **Optimised Software list**](../user-optimised-software) +[Return to the **Optimised Software list**](../dietpi_optimised_software) !!! warning "Documentation in progress..." diff --git a/docs/dietpi-software-system-security.md b/docs/dietpi-software_system_security.md similarity index 88% rename from docs/dietpi-software-system-security.md rename to docs/dietpi-software_system_security.md index 47d520027..cef4e47d8 100644 --- a/docs/dietpi-software-system-security.md +++ b/docs/dietpi-software_system_security.md @@ -5,7 +5,7 @@ - [Fail2Ban - Protects your system from brute-force attacks](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=30#p452) - [Docker - Build, ship, and run distributed applications](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=110#p9120) -[Return to the **Optimised Software list**](../user-optimised-software) +[Return to the **Optimised Software list**](../dietpi_optimised_software) !!! warning "Documentation in progress..." diff --git a/docs/dietpi-software-system-stats.md b/docs/dietpi-software_system_stats.md similarity index 93% rename from docs/dietpi-software-system-stats.md rename to docs/dietpi-software_system_stats.md index f7ee5cf70..fc2004272 100644 --- a/docs/dietpi-software-system-stats.md +++ b/docs/dietpi-software_system_stats.md @@ -10,7 +10,7 @@ - [NetData - Web interface system stats](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=60#p1611) - [Webmin - Remote system management with web interface](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=80#p3047) -[Return to the **Optimised Software list**](../user-optimised-software) +[Return to the **Optimised Software list**](../dietpi_optimised_software) !!! warning "Documentation in progress..." diff --git a/docs/dietpi-software-vpn.md b/docs/dietpi-software_vpn.md similarity index 91% rename from docs/dietpi-software-vpn.md rename to docs/dietpi-software_vpn.md index 233d98e65..720663adb 100644 --- a/docs/dietpi-software-vpn.md +++ b/docs/dietpi-software_vpn.md @@ -7,7 +7,7 @@ - [PiVPN - OpenVPN server installer & management tool](https://dietpi.com/phpbb/viewtopic.php?p=3469#p3469) - [WireGuard - An extremely simple yet fast and modern VPN](https://dietpi.com/phpbb/viewtopic.php?p=16308#p16308) -[Return to the **Optimised Software list**](../user-optimised-software) +[Return to the **Optimised Software list**](../dietpi_optimised_software) !!! warning "Documentation in progress..." diff --git a/docs/dietpi-software-webserver-stack.md b/docs/dietpi-software_webserver_stack.md similarity index 95% rename from docs/dietpi-software-webserver-stack.md rename to docs/dietpi-software_webserver_stack.md index 9326f28f8..ff99557a2 100644 --- a/docs/dietpi-software-webserver-stack.md +++ b/docs/dietpi-software_webserver_stack.md @@ -18,7 +18,7 @@ - [Nginx - Lightweight webserver](https://dietpi.com/phpbb/viewtopic.php?p=1549#p1549) - [Lighttpd - Extremely lightweight webserver](https://dietpi.com/phpbb/viewtopic.php?p=1549#p1549) -[Return to the **Optimised Software list**](../user-optimised-software) +[Return to the **Optimised Software list**](../dietpi_optimised_software) !!! warning "Documentation in progress..." diff --git a/docs/dietpi-software-wifi-hotspot.md b/docs/dietpi-software_wifi_hotspot.md similarity index 88% rename from docs/dietpi-software-wifi-hotspot.md rename to docs/dietpi-software_wifi_hotspot.md index a9744520b..e7ba78375 100644 --- a/docs/dietpi-software-wifi-hotspot.md +++ b/docs/dietpi-software_wifi_hotspot.md @@ -5,7 +5,7 @@ - [WiFi HotSpot - Turn your device into a wireless hotspot/access point.](https://dietpi.com/phpbb/viewtopic.php?p=1207#p1207) - [Tor HotSpot - Optional: Routes all WiFi HotSpot traffic through the Tor network.](https://dietpi.com/phpbb/viewtopic.php?p=1529#p1529) -[Return to the **Optimised Software list**](../user-optimised-software) +[Return to the **Optimised Software list**](../dietpi_optimised_software) !!! warning "Documentation in progress..." diff --git a/docs/user-optimised-software.md b/docs/dietpi_optimised_software.md similarity index 100% rename from docs/user-optimised-software.md rename to docs/dietpi_optimised_software.md diff --git a/docs/hardware-supported_sbc.md b/docs/dietpi_sbc.md similarity index 99% rename from docs/hardware-supported_sbc.md rename to docs/dietpi_sbc.md index 08f573f76..d4a5a5220 100644 --- a/docs/hardware-supported_sbc.md +++ b/docs/dietpi_sbc.md @@ -8,7 +8,7 @@ title: DietPi Supported SBCs ## Raspberry Pi The Raspberry Pi has sold more than 31 million units since it launched in 2012. Any Raspberry Pi can serve as a secondary computer for email and web surfing. The real fun starts when you use your Pi for projects, which can range from robots to retro arcade machines to home media servers, security cameras and so on. -You can install DietPi by following the step by step [Starting guide](../user-guide_install/). +You can install DietPi by following the step by step [Starting guide](../user-guide_install_sbc/).
diff --git a/docs/user-guide_tools.md b/docs/dietpi_tools.md similarity index 100% rename from docs/user-guide_tools.md rename to docs/dietpi_tools.md diff --git a/docs/index.md b/docs/index.md index cc55651fc..f5b870b7c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -30,7 +30,7 @@ our images start at 400MB in size (3x lighter than 'Raspbian Lite'). With featur ## Getting started -If you are **new to DietPi**, the [_Install_](user-guide_install) provides a tutorial for everything you need to get DietPi running. +If you are **new to DietPi**, the [_Install_](user-guide_install_sbc) provides a tutorial for everything you need to get DietPi running. If you **need help**, and have read through [_Getting Started_](user-guide_overview), check out [_Troubleshooting_](https://dietpi.com/phpbb/viewforum.php?f=11). @@ -38,7 +38,7 @@ For more details visit the [_DietPi Community Forum_](https://dietpi.com/phpbb/v ## Easy to install popular software -You can **quickly and easily install popular software** ! All of them are **READY TO RUN** and optimised for your system. The list of available apps is long , and for the full list checkout [_DietPi Optimised Software_](user-optimised-software) page. Here are few highlights: +You can **quickly and easily install popular software** ! All of them are **READY TO RUN** and optimised for your system. The list of available apps is long , and for the full list checkout [_DietPi Optimised Software_](dietpi_optimised_software) page. Here are few highlights: - Desktops (MATE/Xfce) - Remote Desktop (VNC/NoMachine) @@ -47,7 +47,7 @@ You can **quickly and easily install popular software** ! All of them are **READ - Cloud/Backup (Nextcloud/Syncthing) - Gaming (Amiberry/MineOS) - Social, Surveillance, Hotspots, System Stats, Hardware Projects, Stacks (LAMP/LEMP), Pi-hole, VPN, File Servers, Home Automation and Printing -and [much more...](user-optimised-software) +and [much more...](dietpi_optimised_software) DietPi does everything for you, giving you more time to enjoy the software you need. diff --git a/docs/release-notes-updates.md b/docs/release-notes.md similarity index 100% rename from docs/release-notes-updates.md rename to docs/release-notes.md diff --git a/docs/user-guide_install_VirtualBox.md b/docs/user-guide_install_VirtualBox.md index 65af6c516..1a8ef69b6 100644 --- a/docs/user-guide_install_VirtualBox.md +++ b/docs/user-guide_install_VirtualBox.md @@ -58,5 +58,5 @@ Press the start button (green arrow) to 'boot up' your system based on the DietP If you do not have a wired LAN connection you have to change the network settings matching to your environment (files ___\boot\dietpi.txt___ and ___\boot\dietpi-wifi.txt___). Then go on with - https://dietpi.com/docs/user-guide_install/#3-first-boot-on-dietpi + https://dietpi.com/docs/user-guide_install_sbc/#3-first-boot-on-dietpi and follow the instructions there for the first startup of the virtual machine. diff --git a/docs/user-guide_install.md b/docs/user-guide_install_sbc.md similarity index 99% rename from docs/user-guide_install.md rename to docs/user-guide_install_sbc.md index 9caeced70..ef2b6ca1e 100644 --- a/docs/user-guide_install.md +++ b/docs/user-guide_install_sbc.md @@ -126,7 +126,7 @@ You can change the password again later by typing `passwd` at the terminal. ## 4. Install software with the DietPi-Software tool -The base installation of DietPi is minimal **by design**, allowing you to choose what software you want to install and use. If you’re unsure what software to install, checkout [DietPi Optimised Software](../user-optimised-software) page for more details. +The base installation of DietPi is minimal **by design**, allowing you to choose what software you want to install and use. If you’re unsure what software to install, checkout [DietPi Optimised Software](../dietpi_optimised_software) page for more details. !!! info "How do I run **DietPi-Software** and install **Optimised software** ?" diff --git a/docs/user-guide_install_uefi.md b/docs/user-guide_install_uefi.md index 526ac5ceb..fc8fa4684 100644 --- a/docs/user-guide_install_uefi.md +++ b/docs/user-guide_install_uefi.md @@ -89,4 +89,4 @@ At first disconnect your USB stick from the target PC. Then power on the PC. The ![dietpi-boot-start](assets/images/dietpi-boot-start.jpg) -[Follow the rest of initialization](../user-guide_install/#3-first-boot-on-dietpi). This is similar to the SBC installation. +[Follow the rest of initialization](../user-guide_install_sbc/#3-first-boot-on-dietpi). This is similar to the SBC installation. diff --git a/docs/user-guide_overview.md b/docs/user-guide_overview.md index 058a816df..0f880f914 100644 --- a/docs/user-guide_overview.md +++ b/docs/user-guide_overview.md @@ -2,7 +2,7 @@ ## Overview -Once you did the [DietPi Installation](../user-guide_install) you could choose to install one or more [Optimised software](../user-optimised-software) items or run one of the [DietPi tools](../user-guide_tools). +Once you did the [DietPi Installation](../user-guide_install_sbc) you could choose to install one or more [Optimised software](../dietpi_optimised_software) items or run one of the [DietPi tools](../user-guide_tools). ## Initial start @@ -18,9 +18,9 @@ Once you run `dietpi-launcher` you could see all available DietPi tools. It prov ## Choose the software you need -Start by selecting one or more [_DietPi Optimised Software_](../user-optimised-software) for your system. +Start by selecting one or more [_DietPi Optimised Software_](../dietpi_optimised_software) for your system. -The list includes desktop environments, Remote Desktop, Media Systems/Players, Torrents/Downloading (Transmission, Cloud/Backup, Gaming, Social, Surveillance, Hotspots, System Stats, Hardware Projects, Stacks (LAMP/LEMP), Pi-hole, PiVPN, File Servers, Home Automation, Printing, and [much more...](../user-optimised-software). +The list includes desktop environments, Remote Desktop, Media Systems/Players, Torrents/Downloading (Transmission, Cloud/Backup, Gaming, Social, Surveillance, Hotspots, System Stats, Hardware Projects, Stacks (LAMP/LEMP), Pi-hole, PiVPN, File Servers, Home Automation, Printing, and [much more...](../dietpi_optimised_software). ## Supported SBC diff --git a/mkdocs.yml b/mkdocs.yml index e68bf0644..7a04cff41 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -59,6 +59,7 @@ markdown_extensions: - pymdownx.emoji: emoji_index: !!python/name:materialx.emoji.twemoji emoji_generator: !!python/name:materialx.emoji.to_svg + plugins: - search - minify: @@ -69,6 +70,39 @@ plugins: remove_empty_space: true reduce_boolean_attributes: true + - redirects: + redirect_maps: + 'dietpi-software-bittorrent.md': 'dietpi-software_bittorrent.md' + 'user-guide_install_VirtualBox.md' : 'user-guide_install_virtualbox.md' + 'user-optimised-software.md' : 'dietpi_optimised_software.md' + 'user-guide-install.md' : 'user-guide_install_sbc.md' + 'user-guide_install.md' : 'user-guide_install_sbc.md' + 'hardware-supported_sbc.md' : 'dietpi_sbc.md' + 'user-guide_tools.md' : 'dietpi_tools.md' + 'release-notes-updates.md' : 'release-notes.md' + 'dietpi-software-desktop.md' : 'dietpi-software_desktop.md' + 'dietpi-software-media.md' : 'dietpi-software_media.md' + 'dietpi-software-remote-desktop.md' : 'dietpi-software_remote_desktop.md' + 'dietpi-software-cloud.md' : 'dietpi-software_cloud.md' + 'dietpi-software_bittorrent.md' : 'dietpi-software_bittorrent.md' + 'dietpi-software-gaming.md' : 'dietpi-software_gaming.md' + 'dietpi-software-camera.md' : 'dietpi-software_camera.md' + 'dietpi-software-social.md' : 'dietpi-software_social.md' + 'dietpi-software-wifi-hotspot.md' : 'dietpi-software_wifi_hotspot.md' + 'dietpi-software-home-automation.md' : 'dietpi-software_home_automation.md' + 'dietpi-software-hardware-projects.md' : 'dietpi-software_hardware_projects.md' + 'dietpi-software-system-stats.md' : 'dietpi-software_system_stats.md' + 'dietpi-software-system-security.md' : 'dietpi-software_system_security.md' + 'dietpi-software-webserver-stack.md' : 'dietpi-software_webserver_stack.md' + 'dietpi-software-dns-servers.md' : 'dietpi-software_dns_servers.md' + 'dietpi-software-file-servers.md' : 'dietpi-software_file_servers.md' + 'dietpi-software-vpn.md' : 'dietpi-software_vpn.md' + 'dietpi-software-load-balancer.md' : 'dietpi-software_load_balancer.md' + 'dietpi-software-printing.md' : 'dietpi-software_printing.md' + 'dietpi-software-computational-science.md' : 'dietpi-software_computational_science.md' + 'dietpi-software-ssh.md' : 'dietpi-software_ssh.md' + 'dietpi-software-log-system.md' : 'dietpi-software_log_system.md' + extra: social: - icon: fontawesome/brands/github @@ -84,42 +118,42 @@ extra_css: nav: - 'HOME' : - 'Overview' : index.md - - 'Installation' : 'user-guide_install.md' - - ' > Advanced installation' : + - 'Installation' : + - 'Install DietPi on SBC' : 'user-guide_install_sbc.md' - 'Install DietPi on native PC' : 'user-guide_install_uefi.md' - - 'Install DietPi in Oracle VirtualBox' : 'user-guide_install_VirtualBox.md' + - 'Install DietPi in Oracle VirtualBox' : 'user-guide_install_virtualbox.md' - 'Getting started' : 'user-guide_overview.md' - - 'Optimised software list' : 'user-optimised-software.md' - - 'Supported SBC' : 'hardware-supported_sbc.md' + - 'Optimised software list' : 'dietpi_optimised_software.md' + - 'Supported SBC' : 'dietpi_sbc.md' - 'Community Tutorials' : 'https://dietpi.com/phpbb/viewforum.php?f=15' - - 'Advanced configuration & DietPi Tools' : 'user-guide_tools.md' + - 'Advanced configuration & DietPi Tools' : 'dietpi_tools.md' - 'Troubleshooting' : 'https://dietpi.com/phpbb/viewforum.php?f=11' - - 'Release notes' : 'release-notes-updates.md' + - 'Release notes' : 'release-notes.md' - 'Request features' : 'https://github.com/MichaIng/DietPi/issues/new/choose' - 'Report issues' : 'https://github.com/MichaIng/DietPi/issues' - 'OPTIMISED SOFTWARE' : - - 'Desktops & Utilities' : 'dietpi-software-desktop.md' - - 'Media Systems': 'dietpi-software-media.md' - - 'Remote Desktop & Remote Access' : 'dietpi-software-remote-desktop.md' - - 'Cloud & Backups' : 'dietpi-software-cloud.md' - - 'BitTorrent / Download Tools' : 'dietpi-software-bittorrent.md' - - 'Gaming / Emulation' : 'dietpi-software-gaming.md' - - 'Camera / Surveillance' : 'dietpi-software-camera.md' - - 'Social / Search' : 'dietpi-software-social.md' - - 'WiFi Hotspot' : 'dietpi-software-wifi-hotspot.md' - - 'Home Automation' : 'dietpi-software-home-automation.md' - - 'Hardware Projects' : 'dietpi-software-hardware-projects.md' - - 'System Stats / Management' : 'dietpi-software-system-stats.md' - - 'System Security' : 'dietpi-software-system-security.md' - - 'Webserves & Web stacks' : 'dietpi-software-webserver-stack.md' - - 'DNS Servers' : 'dietpi-software-dns-servers.md' - - 'File Servers' : 'dietpi-software-file-servers.md' - - 'VPN' : 'dietpi-software-vpn.md' - - 'Network Load Balancer' : 'dietpi-software-load-balancer.md' - - 'Printing servers' : 'dietpi-software-printing.md' - - 'Computational science' : 'dietpi-software-computational-science.md' - - 'SSH Servers' : 'dietpi-software-ssh.md' - - 'Log System Servers' : 'dietpi-software-log-system.md' + - 'Desktops & Utilities' : 'dietpi-software_desktop.md' + - 'Media Systems': 'dietpi-software_media.md' + - 'Remote Desktop & Remote Access' : 'dietpi-software_remote_desktop.md' + - 'Cloud & Backups' : 'dietpi-software_cloud.md' + - 'BitTorrent / Download Tools' : 'dietpi-software_bittorrent.md' + - 'Gaming / Emulation' : 'dietpi-software_gaming.md' + - 'Camera / Surveillance' : 'dietpi-software_camera.md' + - 'Social / Search' : 'dietpi-software_social.md' + - 'WiFi Hotspot' : 'dietpi-software_wifi_hotspot.md' + - 'Home Automation' : 'dietpi-software_home_automation.md' + - 'Hardware Projects' : 'dietpi-software_hardware_projects.md' + - 'System Stats / Management' : 'dietpi-software_system_stats.md' + - 'System Security' : 'dietpi-software_system_security.md' + - 'Webserves & Web stacks' : 'dietpi-software_webserver_stack.md' + - 'DNS Servers' : 'dietpi-software_dns_servers.md' + - 'File Servers' : 'dietpi-software_file_servers.md' + - 'VPN' : 'dietpi-software_vpn.md' + - 'Network Load Balancer' : 'dietpi-software_load_balancer.md' + - 'Printing servers' : 'dietpi-software_printing.md' + - 'Computational science' : 'dietpi-software_computational_science.md' + - 'SSH Servers' : 'dietpi-software_ssh.md' + - 'Log System Servers' : 'dietpi-software_log_system.md' - 'COMMUNITY' : - 'DietPi Forums & Community' : 'https://dietpi.com/phpbb/viewforum.php?f=5' diff --git a/requirements.txt b/requirements.txt index ef9c7867a..cd7bf849e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,4 @@ mkdocs mkdocs-material mkdocs-minify-plugin +mkdocs-redirects From a44a8a7f8a2583a86ab47cc08a90468073879930 Mon Sep 17 00:00:00 2001 From: fpetru Date: Fri, 9 Oct 2020 20:49:58 +0200 Subject: [PATCH 07/14] Shorten URLs --- docs/dietpi-software_log_system.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/dietpi-software_log_system.md b/docs/dietpi-software_log_system.md index f255e1562..3f44df275 100644 --- a/docs/dietpi-software_log_system.md +++ b/docs/dietpi-software_log_system.md @@ -6,8 +6,8 @@ The links redirect to the old documentation available on [DietPi.com Forum](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5). **We need your help to create and update this documentation ! Thank you** :octicons-heart-16: :octicons-heart-16: -- [DietPi-RAMlog - Lightweight RAM logging.](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=20#p68) -- [Full - Full logging system with Rsyslog and Logrotate.](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=20#p68) +- [DietPi-RAMlog - Lightweight RAM logging.](https://dietpi.com/phpbb/viewtopic.php?p=68#p68) +- [Full - Full logging system with Rsyslog and Logrotate.](https://dietpi.com/phpbb/viewtopic.php?p=68#p68) [Return to the **Optimised Software list**](../dietpi_optimised_software) From 208061692bf45ac7f4ba91dcdded1856f2430cda Mon Sep 17 00:00:00 2001 From: fpetru Date: Fri, 9 Oct 2020 21:10:57 +0200 Subject: [PATCH 08/14] create optimised software folder --- .../bittorrent.md} | 2 +- .../camera.md} | 0 .../cloud.md} | 4 +- .../computational_science.md} | 0 .../desktop.md} | 18 ++-- .../dns_servers.md} | 0 .../file_servers.md} | 0 .../gaming.md} | 0 .../hardware_projects.md} | 0 .../home_automation.md} | 0 .../load_balancer.md} | 0 .../log_system.md} | 0 .../media.md} | 0 .../printing.md} | 0 .../remote_desktop.md} | 4 +- .../social.md} | 0 .../ssh.md} | 0 .../system_security.md} | 0 .../system_stats.md} | 0 .../vpn.md} | 0 .../webserver_stack.md} | 0 .../wifi_hotspot.md} | 0 mkdocs.yml | 90 +++++++++---------- 23 files changed, 59 insertions(+), 59 deletions(-) rename docs/{dietpi-software_bittorrent.md => software/bittorrent.md} (98%) rename docs/{dietpi-software_camera.md => software/camera.md} (100%) rename docs/{dietpi-software_cloud.md => software/cloud.md} (96%) rename docs/{dietpi-software_computational_science.md => software/computational_science.md} (100%) rename docs/{dietpi-software_desktop.md => software/desktop.md} (89%) rename docs/{dietpi-software_dns_servers.md => software/dns_servers.md} (100%) rename docs/{dietpi-software_file_servers.md => software/file_servers.md} (100%) rename docs/{dietpi-software_gaming.md => software/gaming.md} (100%) rename docs/{dietpi-software_hardware_projects.md => software/hardware_projects.md} (100%) rename docs/{dietpi-software_home_automation.md => software/home_automation.md} (100%) rename docs/{dietpi-software_load_balancer.md => software/load_balancer.md} (100%) rename docs/{dietpi-software_log_system.md => software/log_system.md} (100%) rename docs/{dietpi-software_media.md => software/media.md} (100%) rename docs/{dietpi-software_printing.md => software/printing.md} (100%) rename docs/{dietpi-software_remote_desktop.md => software/remote_desktop.md} (96%) rename docs/{dietpi-software_social.md => software/social.md} (100%) rename docs/{dietpi-software_ssh.md => software/ssh.md} (100%) rename docs/{dietpi-software_system_security.md => software/system_security.md} (100%) rename docs/{dietpi-software_system_stats.md => software/system_stats.md} (100%) rename docs/{dietpi-software_vpn.md => software/vpn.md} (100%) rename docs/{dietpi-software_webserver_stack.md => software/webserver_stack.md} (100%) rename docs/{dietpi-software_wifi_hotspot.md => software/wifi_hotspot.md} (100%) diff --git a/docs/dietpi-software_bittorrent.md b/docs/software/bittorrent.md similarity index 98% rename from docs/dietpi-software_bittorrent.md rename to docs/software/bittorrent.md index 9c3449794..7356f9a59 100644 --- a/docs/dietpi-software_bittorrent.md +++ b/docs/software/bittorrent.md @@ -40,7 +40,7 @@ Key features: === "Quick start" After installation access the web interface using port **6767** (ex: http://192.168.0.100:6767) - ![Bazarr](assets/images/dietpi-software-download-bazarr.jpg) + ![Bazarr](../assets/images/dietpi-software-download-bazarr.jpg) === "Advanced" diff --git a/docs/dietpi-software_camera.md b/docs/software/camera.md similarity index 100% rename from docs/dietpi-software_camera.md rename to docs/software/camera.md diff --git a/docs/dietpi-software_cloud.md b/docs/software/cloud.md similarity index 96% rename from docs/dietpi-software_cloud.md rename to docs/software/cloud.md index bf637ec19..b4a0f26f0 100644 --- a/docs/dietpi-software_cloud.md +++ b/docs/software/cloud.md @@ -32,7 +32,7 @@ Choose **Software optimised** and select one or more items. Finally click on `Install`. DietPi will do all the necessary steps to install and start these software items. - ![DietPi Software](assets/images/dietpi-software.jpg) + ![DietPi Software](../assets/images/dietpi-software.jpg) To see all the DietPi configurations options, review [DietPi Tools](../user-guide_tools) section. @@ -75,4 +75,4 @@ Nextcloud gives you access to all your files wherever you are. Store your docume [Nextcloud Website](https://nextcloud.com/athome/) -![DietPi-Software-NextCloud](assets/images/dietpi-software-cloud-nextcloud.jpg) +![DietPi-Software-NextCloud](../assets/images/dietpi-software-cloud-nextcloud.jpg) diff --git a/docs/dietpi-software_computational_science.md b/docs/software/computational_science.md similarity index 100% rename from docs/dietpi-software_computational_science.md rename to docs/software/computational_science.md diff --git a/docs/dietpi-software_desktop.md b/docs/software/desktop.md similarity index 89% rename from docs/dietpi-software_desktop.md rename to docs/software/desktop.md index 1aade6200..0051638b1 100644 --- a/docs/dietpi-software_desktop.md +++ b/docs/software/desktop.md @@ -31,7 +31,7 @@ Choose **Software optimised** and select one or more items. Finally click on `Install`. DietPi will do all the necessary steps to install and start these software items. - ![DietPi Software](assets/images/dietpi-software.jpg) + ![DietPi Software](../assets/images/dietpi-software.jpg) To see all the DietPi configurations options, review [DietPi Tools](../user-guide_tools) section. @@ -58,7 +58,7 @@ LXDE is highly optimized and ultra lightweight desktop. It works well with compu === "Official documentation" [LXDE Website](https://www.lxde.org) - [LXDE Wiki](https://wiki.lxde.org/en/Main_Page) -![DietPi LXDE](assets/images/dietpi-software-LXDE_desktop.jpg) +![DietPi LXDE](../assets/images/dietpi-software-LXDE_desktop.jpg) ## LXQt - Optimized lightweight desktop Optimized lightweight desktop without the bloatware. Slick and fluid GUI, however, more resource heavy than LXDE. @@ -91,7 +91,7 @@ Popular Gnome2 based desktop environment. === "Official documentation" [MATE Desktop website](https://mate-desktop.org/) -![DietPi LXDE](assets/images/dietpi-software-mate-desktop.jpg) +![DietPi LXDE](../assets/images/dietpi-software-mate-desktop.jpg) ## Xfce - Lightweight desktop @@ -107,7 +107,7 @@ Popular Gnome2 based desktop environment. === "Official documentation" [Xfce website](https://wiki.debian.org/Xfce) -![DietPi Xfce](assets/images/dietpi-software-xfce-desktop.jpg) +![DietPi Xfce](../assets/images/dietpi-software-xfce-desktop.jpg) ## GnuStep - Alternative/unique desktop @@ -123,7 +123,7 @@ Popular Gnome2 based desktop environment. === "Official documentation" [GNUstep website](http://gnustep.org/) -![DietPi GNUstep](assets/images/dietpi-software-gnustep-desktop.jpg) +![DietPi GNUstep](../assets/images/dietpi-software-gnustep-desktop.jpg) ## Desktop utilities @@ -145,23 +145,23 @@ Once Chromium is running, simply go to the following address: - Manually: [https://blog.vpetkov.net/2019/07/12/net ... -chromium/](https://blog.vpetkov.net/2019/07/12/netflix-and-spotify-on-a-raspberry-pi-4-with-latest-default-chromium/) - with scripts: [https://blog.vpetkov.net/2020/03/30/ras ... ny-others/](https://blog.vpetkov.net/2020/03/30/raspberry-pi-netflix-one-line-easy-install-along-with-hulu-amazon-prime-disney-plus-hbo-spotify-pandora-and-many-others/) -![DietPi GIMP](assets/images/dietpi-software-desktop-tools-chromium.jpg) +![DietPi GIMP](../assets/images/dietpi-software-desktop-tools-chromium.jpg) ### GIMP - Image editor MS Paint on steroids. If you need to edit pixels with a vast number of tools, GIMP is the only program you'll need. -![DietPi GIMP](assets/images/dietpi-software-desktop-tools-gimp.jpg) +![DietPi GIMP](../assets/images/dietpi-software-desktop-tools-gimp.jpg) https://www.gimp.org/ ### QuiteRSS - Atom news feeds reader QuiteRSS is a open-source cross-platform RSS / Atom news feeds reader, with the main idea to be fast and comfortable to the end-user. -![DietPi QuiteRSS](assets/images/dietpi-software-desktop-tools-quiterss.jpg) +![DietPi QuiteRSS](../assets/images/dietpi-software-desktop-tools-quiterss.jpg) ### Xfce4 Power - Power manager with brightness Enables laptop users to set up a power profile for two different modes `on battery power` and `on AC Power` while still allowing desktop users to at least change the DPMS settings and CPU frequency using the settings dialogue. -![DietPi Xfce4 Power manager](assets/images/dietpi-software-desktop-tools-xfce4-power-manager.jpg) +![DietPi Xfce4 Power manager](../assets/images/dietpi-software-desktop-tools-xfce4-power-manager.jpg) diff --git a/docs/dietpi-software_dns_servers.md b/docs/software/dns_servers.md similarity index 100% rename from docs/dietpi-software_dns_servers.md rename to docs/software/dns_servers.md diff --git a/docs/dietpi-software_file_servers.md b/docs/software/file_servers.md similarity index 100% rename from docs/dietpi-software_file_servers.md rename to docs/software/file_servers.md diff --git a/docs/dietpi-software_gaming.md b/docs/software/gaming.md similarity index 100% rename from docs/dietpi-software_gaming.md rename to docs/software/gaming.md diff --git a/docs/dietpi-software_hardware_projects.md b/docs/software/hardware_projects.md similarity index 100% rename from docs/dietpi-software_hardware_projects.md rename to docs/software/hardware_projects.md diff --git a/docs/dietpi-software_home_automation.md b/docs/software/home_automation.md similarity index 100% rename from docs/dietpi-software_home_automation.md rename to docs/software/home_automation.md diff --git a/docs/dietpi-software_load_balancer.md b/docs/software/load_balancer.md similarity index 100% rename from docs/dietpi-software_load_balancer.md rename to docs/software/load_balancer.md diff --git a/docs/dietpi-software_log_system.md b/docs/software/log_system.md similarity index 100% rename from docs/dietpi-software_log_system.md rename to docs/software/log_system.md diff --git a/docs/dietpi-software_media.md b/docs/software/media.md similarity index 100% rename from docs/dietpi-software_media.md rename to docs/software/media.md diff --git a/docs/dietpi-software_printing.md b/docs/software/printing.md similarity index 100% rename from docs/dietpi-software_printing.md rename to docs/software/printing.md diff --git a/docs/dietpi-software_remote_desktop.md b/docs/software/remote_desktop.md similarity index 96% rename from docs/dietpi-software_remote_desktop.md rename to docs/software/remote_desktop.md index 551ff73b8..1027042fc 100644 --- a/docs/dietpi-software_remote_desktop.md +++ b/docs/software/remote_desktop.md @@ -29,7 +29,7 @@ Choose **Software optimised** and select one or more items. Finally click on `Install`. DietPi will do all the necessary steps to install and start these software items. - ![DietPi Software](assets/images/dietpi-software.jpg) + ![DietPi Software](../assets/images/dietpi-software.jpg) To see all the DietPi configurations options, review [DietPi Tools](../user-guide_tools) section. @@ -74,7 +74,7 @@ Run a **Desktop environment** on your device and access it accessed remotely via === "Official documentation" [LXDE Website](https://www.lxde.org) - [LXDE Wiki](https://wiki.lxde.org/en/Main_Page) -![DietPi-Remote-Desktop-TigerVNC](assets/images/dietpi-software-remote-desktop-tigervnc.jpg) +![DietPi-Remote-Desktop-TigerVNC](../assets/images/dietpi-software-remote-desktop-tigervnc.jpg) ### VNC Server - Shared desktop diff --git a/docs/dietpi-software_social.md b/docs/software/social.md similarity index 100% rename from docs/dietpi-software_social.md rename to docs/software/social.md diff --git a/docs/dietpi-software_ssh.md b/docs/software/ssh.md similarity index 100% rename from docs/dietpi-software_ssh.md rename to docs/software/ssh.md diff --git a/docs/dietpi-software_system_security.md b/docs/software/system_security.md similarity index 100% rename from docs/dietpi-software_system_security.md rename to docs/software/system_security.md diff --git a/docs/dietpi-software_system_stats.md b/docs/software/system_stats.md similarity index 100% rename from docs/dietpi-software_system_stats.md rename to docs/software/system_stats.md diff --git a/docs/dietpi-software_vpn.md b/docs/software/vpn.md similarity index 100% rename from docs/dietpi-software_vpn.md rename to docs/software/vpn.md diff --git a/docs/dietpi-software_webserver_stack.md b/docs/software/webserver_stack.md similarity index 100% rename from docs/dietpi-software_webserver_stack.md rename to docs/software/webserver_stack.md diff --git a/docs/dietpi-software_wifi_hotspot.md b/docs/software/wifi_hotspot.md similarity index 100% rename from docs/dietpi-software_wifi_hotspot.md rename to docs/software/wifi_hotspot.md diff --git a/mkdocs.yml b/mkdocs.yml index 7a04cff41..42d646314 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -72,7 +72,7 @@ plugins: - redirects: redirect_maps: - 'dietpi-software-bittorrent.md': 'dietpi-software_bittorrent.md' + 'dietpi-software-bittorrent.md': 'software/bittorrent.md' 'user-guide_install_VirtualBox.md' : 'user-guide_install_virtualbox.md' 'user-optimised-software.md' : 'dietpi_optimised_software.md' 'user-guide-install.md' : 'user-guide_install_sbc.md' @@ -80,28 +80,28 @@ plugins: 'hardware-supported_sbc.md' : 'dietpi_sbc.md' 'user-guide_tools.md' : 'dietpi_tools.md' 'release-notes-updates.md' : 'release-notes.md' - 'dietpi-software-desktop.md' : 'dietpi-software_desktop.md' - 'dietpi-software-media.md' : 'dietpi-software_media.md' - 'dietpi-software-remote-desktop.md' : 'dietpi-software_remote_desktop.md' - 'dietpi-software-cloud.md' : 'dietpi-software_cloud.md' - 'dietpi-software_bittorrent.md' : 'dietpi-software_bittorrent.md' - 'dietpi-software-gaming.md' : 'dietpi-software_gaming.md' - 'dietpi-software-camera.md' : 'dietpi-software_camera.md' - 'dietpi-software-social.md' : 'dietpi-software_social.md' - 'dietpi-software-wifi-hotspot.md' : 'dietpi-software_wifi_hotspot.md' - 'dietpi-software-home-automation.md' : 'dietpi-software_home_automation.md' - 'dietpi-software-hardware-projects.md' : 'dietpi-software_hardware_projects.md' - 'dietpi-software-system-stats.md' : 'dietpi-software_system_stats.md' - 'dietpi-software-system-security.md' : 'dietpi-software_system_security.md' - 'dietpi-software-webserver-stack.md' : 'dietpi-software_webserver_stack.md' - 'dietpi-software-dns-servers.md' : 'dietpi-software_dns_servers.md' - 'dietpi-software-file-servers.md' : 'dietpi-software_file_servers.md' - 'dietpi-software-vpn.md' : 'dietpi-software_vpn.md' - 'dietpi-software-load-balancer.md' : 'dietpi-software_load_balancer.md' - 'dietpi-software-printing.md' : 'dietpi-software_printing.md' - 'dietpi-software-computational-science.md' : 'dietpi-software_computational_science.md' - 'dietpi-software-ssh.md' : 'dietpi-software_ssh.md' - 'dietpi-software-log-system.md' : 'dietpi-software_log_system.md' + 'dietpi-software-desktop.md' : 'software/desktop.md' + 'dietpi-software-media.md' : 'software/media.md' + 'dietpi-software-remote-desktop.md' : 'software/remote_desktop.md' + 'dietpi-software-cloud.md' : 'software/cloud.md' + 'dietpi-software_bittorrent.md' : 'software/bittorrent.md' + 'dietpi-software-gaming.md' : 'software/gaming.md' + 'dietpi-software-camera.md' : 'software/camera.md' + 'dietpi-software-social.md' : 'software/social.md' + 'dietpi-software-wifi-hotspot.md' : 'software/wifi_hotspot.md' + 'dietpi-software-home-automation.md' : 'software/home_automation.md' + 'dietpi-software-hardware-projects.md' : 'software/hardware_projects.md' + 'dietpi-software-system-stats.md' : 'software/system_stats.md' + 'dietpi-software-system-security.md' : 'software/system_security.md' + 'dietpi-software-webserver-stack.md' : 'software/webserver_stack.md' + 'dietpi-software-dns-servers.md' : 'software/dns_servers.md' + 'dietpi-software-file-servers.md' : 'software/file_servers.md' + 'dietpi-software-vpn.md' : 'software/vpn.md' + 'dietpi-software-load-balancer.md' : 'software/load_balancer.md' + 'dietpi-software-printing.md' : 'software/printing.md' + 'dietpi-software-computational-science.md' : 'software/computational_science.md' + 'dietpi-software-ssh.md' : 'software/ssh.md' + 'dietpi-software-log-system.md' : 'software/log_system.md' extra: social: @@ -132,28 +132,28 @@ nav: - 'Request features' : 'https://github.com/MichaIng/DietPi/issues/new/choose' - 'Report issues' : 'https://github.com/MichaIng/DietPi/issues' - 'OPTIMISED SOFTWARE' : - - 'Desktops & Utilities' : 'dietpi-software_desktop.md' - - 'Media Systems': 'dietpi-software_media.md' - - 'Remote Desktop & Remote Access' : 'dietpi-software_remote_desktop.md' - - 'Cloud & Backups' : 'dietpi-software_cloud.md' - - 'BitTorrent / Download Tools' : 'dietpi-software_bittorrent.md' - - 'Gaming / Emulation' : 'dietpi-software_gaming.md' - - 'Camera / Surveillance' : 'dietpi-software_camera.md' - - 'Social / Search' : 'dietpi-software_social.md' - - 'WiFi Hotspot' : 'dietpi-software_wifi_hotspot.md' - - 'Home Automation' : 'dietpi-software_home_automation.md' - - 'Hardware Projects' : 'dietpi-software_hardware_projects.md' - - 'System Stats / Management' : 'dietpi-software_system_stats.md' - - 'System Security' : 'dietpi-software_system_security.md' - - 'Webserves & Web stacks' : 'dietpi-software_webserver_stack.md' - - 'DNS Servers' : 'dietpi-software_dns_servers.md' - - 'File Servers' : 'dietpi-software_file_servers.md' - - 'VPN' : 'dietpi-software_vpn.md' - - 'Network Load Balancer' : 'dietpi-software_load_balancer.md' - - 'Printing servers' : 'dietpi-software_printing.md' - - 'Computational science' : 'dietpi-software_computational_science.md' - - 'SSH Servers' : 'dietpi-software_ssh.md' - - 'Log System Servers' : 'dietpi-software_log_system.md' + - 'Desktops & Utilities' : 'software/desktop.md' + - 'Media Systems': 'software/media.md' + - 'Remote Desktop & Remote Access' : 'software/remote_desktop.md' + - 'Cloud & Backups' : 'software/cloud.md' + - 'BitTorrent / Download Tools' : 'software/bittorrent.md' + - 'Gaming / Emulation' : 'software/gaming.md' + - 'Camera / Surveillance' : 'software/camera.md' + - 'Social / Search' : 'software/social.md' + - 'WiFi Hotspot' : 'software/wifi_hotspot.md' + - 'Home Automation' : 'software/home_automation.md' + - 'Hardware Projects' : 'software/hardware_projects.md' + - 'System Stats / Management' : 'software/system_stats.md' + - 'System Security' : 'software/system_security.md' + - 'Webserves & Web stacks' : 'software/webserver_stack.md' + - 'DNS Servers' : 'software/dns_servers.md' + - 'File Servers' : 'software/file_servers.md' + - 'VPN' : 'software/vpn.md' + - 'Network Load Balancer' : 'software/load_balancer.md' + - 'Printing servers' : 'software/printing.md' + - 'Computational science' : 'software/computational_science.md' + - 'SSH Servers' : 'software/ssh.md' + - 'Log System Servers' : 'software/log_system.md' - 'COMMUNITY' : - 'DietPi Forums & Community' : 'https://dietpi.com/phpbb/viewforum.php?f=5' From 5cf2b2624a84f37ca79c74c0517671f5e8c5e511 Mon Sep 17 00:00:00 2001 From: fpetru Date: Fri, 9 Oct 2020 21:12:19 +0200 Subject: [PATCH 09/14] remove file with uper case --- docs/user-guide_install_VirtualBox.md | 62 --------------------------- 1 file changed, 62 deletions(-) delete mode 100644 docs/user-guide_install_VirtualBox.md diff --git a/docs/user-guide_install_VirtualBox.md b/docs/user-guide_install_VirtualBox.md deleted file mode 100644 index 1a8ef69b6..000000000 --- a/docs/user-guide_install_VirtualBox.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -description: DietPi installation as an Oracle VirtualBox machine -title: How to install DietPi as an Oracle VirtualBox machine ---- - -# How to install DietPi as an Oracle VirtualBox machine - -## 1. Intro - -Virtual machine images are great for those occasions where you want to set up a DietPi system very quickly and test things. Also it may be used as a debian based linux system with a small footprint for development purposes, e.g. with the X11 window system. The small footprint makes it optimally usable on PCs without a huge built in RAM. Also several VMs may be run for different applications. - -One big advantage of such a VM is that id needs only a couple of minutes coming to a running DietPi system. - -One of the options of a virtual machine is [__Oracle VirtualBox__](https://www.oracle.com/virtualization/virtualbox/). - -![DietPi-VirtualBox-program](assets/images/dietpi-VirtualBox-program.png) - - -## 2. Prerequisites - -As a starting point you need a **PC with a running VirtualBox software** on which the DietPi system will run. -On this PC a free harddisk space of about -- 1.2 GB for a minimal running system -- 5-10 GB for a typical running system with X11 -is needed. A recommended size is at least a free space of 10 GB. - - -## 3. Download and extract the DietPi disk image - -Download the **DietPi VirtualBox file** "DietPi_VirtualBox-x86_64-Buster.7z" from [dietpi.com](https://dietpi.com/#download) and -unzip the downloaded file to a local folder. It is a _7z_ archive format so you will need to install either [7zip for Windows](https://www.7-zip.org/) or other alternative tools. - -![DietPi-download-image](assets/images/dietpi-VirtualBox-Download.png) - -The zip file contains a couple of files, the important one is the .ova file which has to be imported into VirtualBox. - -![Dietpi-zipfile-content](assets/images/dietpi-VirtualBox-7zip-file.png) - - -## 4. Import of the .ova file in VirtualBox - -As next, the VirtualBox virtual machine has to be setup by importing the .ova file (via \File\Import Appliance): - -![DietPi-import-VirtualBoxMachine1](assets/images/dietpi-VirtualBox-import1.png) - -In the following dialog the user hast to choose DietPi_VirtualBox-x86_64-Buster.ova as the file which shall be imported. - -![DietPi-import-VirtualBoxMachine2](assets/images/dietpi-VirtualBox-import2.png) - -Keep the settings in the next dialog and klick “Import”. - -After the importing has finished the DietPi VirtualBox virtual machine is present: - -![DietPi-VirtualBoxMachine1](assets/images/dietpi-VirtualBox-VB-Machine.png) - -## 5. First boot of the new VirtualBox image -Press the start button (green arrow) to 'boot up' your system based on the DietPi image. -If you do not have a wired LAN connection you have to change the network settings matching to your environment (files ___\boot\dietpi.txt___ and ___\boot\dietpi-wifi.txt___). - -Then go on with - https://dietpi.com/docs/user-guide_install_sbc/#3-first-boot-on-dietpi -and follow the instructions there for the first startup of the virtual machine. From e35faaf66c54959066805d94e4fd8ca6940763f2 Mon Sep 17 00:00:00 2001 From: fpetru Date: Fri, 9 Oct 2020 21:13:29 +0200 Subject: [PATCH 10/14] add file with lower case --- docs/user-guide_install_virtualbox.md | 62 +++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 docs/user-guide_install_virtualbox.md diff --git a/docs/user-guide_install_virtualbox.md b/docs/user-guide_install_virtualbox.md new file mode 100644 index 000000000..1a8ef69b6 --- /dev/null +++ b/docs/user-guide_install_virtualbox.md @@ -0,0 +1,62 @@ +--- +description: DietPi installation as an Oracle VirtualBox machine +title: How to install DietPi as an Oracle VirtualBox machine +--- + +# How to install DietPi as an Oracle VirtualBox machine + +## 1. Intro + +Virtual machine images are great for those occasions where you want to set up a DietPi system very quickly and test things. Also it may be used as a debian based linux system with a small footprint for development purposes, e.g. with the X11 window system. The small footprint makes it optimally usable on PCs without a huge built in RAM. Also several VMs may be run for different applications. + +One big advantage of such a VM is that id needs only a couple of minutes coming to a running DietPi system. + +One of the options of a virtual machine is [__Oracle VirtualBox__](https://www.oracle.com/virtualization/virtualbox/). + +![DietPi-VirtualBox-program](assets/images/dietpi-VirtualBox-program.png) + + +## 2. Prerequisites + +As a starting point you need a **PC with a running VirtualBox software** on which the DietPi system will run. +On this PC a free harddisk space of about +- 1.2 GB for a minimal running system +- 5-10 GB for a typical running system with X11 +is needed. A recommended size is at least a free space of 10 GB. + + +## 3. Download and extract the DietPi disk image + +Download the **DietPi VirtualBox file** "DietPi_VirtualBox-x86_64-Buster.7z" from [dietpi.com](https://dietpi.com/#download) and +unzip the downloaded file to a local folder. It is a _7z_ archive format so you will need to install either [7zip for Windows](https://www.7-zip.org/) or other alternative tools. + +![DietPi-download-image](assets/images/dietpi-VirtualBox-Download.png) + +The zip file contains a couple of files, the important one is the .ova file which has to be imported into VirtualBox. + +![Dietpi-zipfile-content](assets/images/dietpi-VirtualBox-7zip-file.png) + + +## 4. Import of the .ova file in VirtualBox + +As next, the VirtualBox virtual machine has to be setup by importing the .ova file (via \File\Import Appliance): + +![DietPi-import-VirtualBoxMachine1](assets/images/dietpi-VirtualBox-import1.png) + +In the following dialog the user hast to choose DietPi_VirtualBox-x86_64-Buster.ova as the file which shall be imported. + +![DietPi-import-VirtualBoxMachine2](assets/images/dietpi-VirtualBox-import2.png) + +Keep the settings in the next dialog and klick “Import”. + +After the importing has finished the DietPi VirtualBox virtual machine is present: + +![DietPi-VirtualBoxMachine1](assets/images/dietpi-VirtualBox-VB-Machine.png) + +## 5. First boot of the new VirtualBox image +Press the start button (green arrow) to 'boot up' your system based on the DietPi image. +If you do not have a wired LAN connection you have to change the network settings matching to your environment (files ___\boot\dietpi.txt___ and ___\boot\dietpi-wifi.txt___). + +Then go on with + https://dietpi.com/docs/user-guide_install_sbc/#3-first-boot-on-dietpi +and follow the instructions there for the first startup of the virtual machine. From 621afdb566cd48102ba81427b4266cc6cae9124f Mon Sep 17 00:00:00 2001 From: fpetru Date: Fri, 9 Oct 2020 21:17:51 +0200 Subject: [PATCH 11/14] remove one redirect --- mkdocs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 42d646314..36af7ecb0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -73,7 +73,6 @@ plugins: - redirects: redirect_maps: 'dietpi-software-bittorrent.md': 'software/bittorrent.md' - 'user-guide_install_VirtualBox.md' : 'user-guide_install_virtualbox.md' 'user-optimised-software.md' : 'dietpi_optimised_software.md' 'user-guide-install.md' : 'user-guide_install_sbc.md' 'user-guide_install.md' : 'user-guide_install_sbc.md' From 1dada512a33a302c0e667f5100774c4b21c3625e Mon Sep 17 00:00:00 2001 From: fpetru Date: Fri, 9 Oct 2020 21:29:49 +0200 Subject: [PATCH 12/14] new folder -> change url --- docs/dietpi_optimised_software.md | 28 +++++++++++++------------- docs/software/bittorrent.md | 2 +- docs/software/camera.md | 2 +- docs/software/cloud.md | 2 +- docs/software/computational_science.md | 2 +- docs/software/desktop.md | 2 +- docs/software/dns_servers.md | 2 +- docs/software/file_servers.md | 2 +- docs/software/gaming.md | 3 ++- docs/software/hardware_projects.md | 3 ++- docs/software/home_automation.md | 2 +- docs/software/load_balancer.md | 2 +- docs/software/log_system.md | 2 +- docs/software/media.md | 2 +- docs/software/printing.md | 2 +- docs/software/remote_desktop.md | 2 +- docs/software/social.md | 3 ++- docs/software/ssh.md | 2 +- docs/software/system_security.md | 2 +- docs/software/system_stats.md | 2 +- docs/software/vpn.md | 2 +- docs/software/webserver_stack.md | 2 +- docs/software/wifi_hotspot.md | 2 +- 23 files changed, 39 insertions(+), 36 deletions(-) diff --git a/docs/dietpi_optimised_software.md b/docs/dietpi_optimised_software.md index e5d46c7e1..bdc089746 100644 --- a/docs/dietpi_optimised_software.md +++ b/docs/dietpi_optimised_software.md @@ -17,25 +17,25 @@ ![DietPi Software](assets/images/dietpi-software.jpg) - To see all the DietPi configurations options, review [DietPi Tools](../user-guide_tools) section. + To see all the DietPi configurations options, review [DietPi Tools](../dietpi_tools) section. !!! warning "Documentation in progress..." The **Optimised Software** links marked in **bold** have a more detailed description. The other links redirect to the old documentation (available on [DietPi.com Forum](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5)) -## [Desktops](../dietpi-software-desktop) -- [**LXDE - Highly optimized ultra lightweight desktop**](../dietpi-software-desktop/#lxde-ultra-lightweight-desktop) -- [**LXQt - Slick and optimized lightweight desktop**](../dietpi-software-desktop/#lxqt-optimized-lightweight-desktop) -- [**MATE - Popular Gnome 2 desktop**](../dietpi-software-desktop/#mate-popular-gnome2-desktop) -- [**Xfce - Lightweight desktop**](../dietpi-software-desktop/#xfce-lightweight-desktop) -- [**GnuStep - Alternative/unique desktop**](../dietpi-software-desktop/#gnustep-alternativeunique-desktop) +## [Desktops](../software/desktop) +- [**LXDE - Highly optimized ultra lightweight desktop**](../software/desktop/#lxde-ultra-lightweight-desktop) +- [**LXQt - Slick and optimized lightweight desktop**](../software/desktop/#lxqt-optimized-lightweight-desktop) +- [**MATE - Popular Gnome 2 desktop**](../software/desktop/#mate-popular-gnome2-desktop) +- [**Xfce - Lightweight desktop**](../software/desktop/#xfce-lightweight-desktop) +- [**GnuStep - Alternative/unique desktop**](../software/desktop/#gnustep-alternativeunique-desktop) -### [Desktop Utilities](../dietpi-software-desktop/#desktop-utilities) -- [**Chromium - Web browser**](../dietpi-software-desktop/#chromium-web-browser) -- [**GIMP - Image editor**](../dietpi-software-desktop/#gimp-image-editor) -- [**QuiteRSS - RSS and Atom news feeds reader**](../dietpi-software-desktop/#quiterss-atom-news-feeds-reader) +### [Desktop Utilities](../software/desktop/#desktop-utilities) +- [**Chromium - Web browser**](../software/desktop/#chromium-web-browser) +- [**GIMP - Image editor**](../software/desktop/#gimp-image-editor) +- [**QuiteRSS - RSS and Atom news feeds reader**](../software/desktop/#quiterss-atom-news-feeds-reader) ## Remote Desktop Access -- [**TigerVNC Server - Desktop for remote connection**](../dietpi-software-remote-desktop/#29-tigervnc-server-desktop-for-remote-connection) +- [**TigerVNC Server - Desktop for remote connection**](../software/remote_desktop/#29-tigervnc-server-desktop-for-remote-connection) - [RealVNC Server - Desktop for remote connection](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=80#p4149) - [XRDP - Remote desktop server for Windows Remote Desktop Client](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=70#p2074) - [NoMachine - Feature rich remote desktop connection](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=60#p2071) @@ -80,7 +80,7 @@ - [Medusa - Automatically download TV shows](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=80#p3327) - [Sonarr - Automatically download TV shows](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=100#p7455) - [Radarr - Automatically download Movies](https://dietpi.com/phpbb/viewtopic.php?p=7457#p7457) -- **[Bazarr - Automatically download Subtitles for Sonarr/Radarr](../dietpi-software-bittorrent/#bazarr)** +- **[Bazarr - Automatically download Subtitles for Sonarr/Radarr](../software/bittorrent/#bazarr)** - [Lidarr - Automatically download Music](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=130#p13580) - [CouchPotato - Automatically download movies.](https://dietpi.com/phpbb/viewtopic.php?p=7212#p7212) - [Jackett - API Support for your favourite torrent trackers.](https://dietpi.com/phpbb/viewtopic.php?p=7503#p7503) @@ -105,7 +105,7 @@ ## Cloud & Backup systems - [ownCloud - Your own personal cloud based backup/data storage system](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5#p47) -- [**Nextcloud - Self-hosted productivity platform**](../dietpi-software-cloud/#nextcloud-self-hosted-productivity-platform) +- [**Nextcloud - Self-hosted productivity platform**](../software/cloud/#nextcloud-self-hosted-productivity-platform) - [Nextcloud Talk - Video calls via Nextcloud, including TURN server](https://dietpi.com/phpbb/viewtopic.php?p=15227#p15227) - [Pydio - Feature-rich backup and sync server with web interface.](https://dietpi.com/phpbb/viewtopic.php?p=1064#p1064) - [UrBackup Server - Full backups for systems on your network](https://dietpi.com/phpbb/viewtopic.php?p=65#p65) diff --git a/docs/software/bittorrent.md b/docs/software/bittorrent.md index 7356f9a59..812014ab1 100644 --- a/docs/software/bittorrent.md +++ b/docs/software/bittorrent.md @@ -22,7 +22,7 @@ - [NZBget - NZB download manager with web interface.](https://dietpi.com/phpbb/viewtopic.php?p=7575#p7575) - [HTPC Manager - combines all your favourite software into one slick interface.](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=110#p8043) -[Return to the **Optimised Software list**](../dietpi_optimised_software) +[Return to the **Optimised Software list**](../../dietpi_optimised_software) ## Bazarr diff --git a/docs/software/camera.md b/docs/software/camera.md index 6cdc0c66b..c87272716 100644 --- a/docs/software/camera.md +++ b/docs/software/camera.md @@ -9,4 +9,4 @@ - [RPi Cam Control - RPi Camera / Web Interface Surveillance](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5#p48) - [MotionEye - Camera / Web Interface Surveillance](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=100#p6610) -[Return to the **Optimised Software list**](../dietpi_optimised_software) +[Return to the **Optimised Software list**](../../dietpi_optimised_software) diff --git a/docs/software/cloud.md b/docs/software/cloud.md index b4a0f26f0..5b31deca3 100644 --- a/docs/software/cloud.md +++ b/docs/software/cloud.md @@ -18,7 +18,7 @@ - [Minio - S3 compatible distributed object server](https://dietpi.com/phpbb/viewtopic.php?p=9121#p9121) - [Firefox Sync Server - Sync bookmarks, tabs, history & passwords](https://dietpi.com/phpbb/viewtopic.php?p=24713#p24713) -[Return to the **Optimised Software list**](../dietpi_optimised_software) +[Return to the **Optimised Software list**](../../dietpi_optimised_software) ??? info "How do I run **DietPi-Software** and install **Optimised software** ?" To install any of the **DietPi Optimised Software** listed below run from the command line: diff --git a/docs/software/computational_science.md b/docs/software/computational_science.md index cad0b9081..0e1469fbc 100644 --- a/docs/software/computational_science.md +++ b/docs/software/computational_science.md @@ -8,5 +8,5 @@ - [Folding@Home - Use processing power to assist with disease research](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=130#p13704) -[Return to the **Optimised Software list**](../dietpi_optimised_software) +[Return to the **Optimised Software list**](../../dietpi_optimised_software) diff --git a/docs/software/desktop.md b/docs/software/desktop.md index 0051638b1..ba93fe931 100644 --- a/docs/software/desktop.md +++ b/docs/software/desktop.md @@ -17,7 +17,7 @@ - [QuiteRSS - RSS and Atom news feeds reader](#quiterss-atom-news-feeds-reader) - [Xfce4 Power - Power manager with brightness](#xfce4-power-power-manager-with-brightness) -[Return to the **Optimised Software list**](../dietpi_optimised_software) +[Return to the **Optimised Software list**](../../dietpi_optimised_software) ??? info "How do I run **DietPi-Software** and install **Optimised software** ?" To install any of the **DietPi Optimised Software** listed below run from the command line: diff --git a/docs/software/dns_servers.md b/docs/software/dns_servers.md index 993f50869..563a561d9 100644 --- a/docs/software/dns_servers.md +++ b/docs/software/dns_servers.md @@ -12,4 +12,4 @@ - [No-IP - Website URL Address](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=10#p58) -[Return to the **Optimised Software list**](../dietpi_optimised_software) +[Return to the **Optimised Software list**](../../dietpi_optimised_software) diff --git a/docs/software/file_servers.md b/docs/software/file_servers.md index b8f45dd5a..2f0ec83e4 100644 --- a/docs/software/file_servers.md +++ b/docs/software/file_servers.md @@ -11,4 +11,4 @@ - [vsFTPD - Feature rich FTP file server.](https://dietpi.com/phpbb/viewtopic.php?p=2820#p2820) - [NFS - Network file system server](https://dietpi.com/phpbb/viewtopic.php?p=2821#p2821) -[Return to the **Optimised Software list**](../dietpi_optimised_software) +[Return to the **Optimised Software list**](../../dietpi_optimised_software) diff --git a/docs/software/gaming.md b/docs/software/gaming.md index 13d01fb47..ec16eb7b0 100644 --- a/docs/software/gaming.md +++ b/docs/software/gaming.md @@ -14,5 +14,6 @@ - [DXX-Rebirth - Descent 1 & 2 OpenGL port](https://dietpi.com/phpbb/viewtopic.php?p=2963#p2963) - [Steam - Steam client](https://dietpi.com/phpbb/viewtopic.php?p=8016#p8016) -[Return to the **Optimised Software list**](../dietpi_optimised_software) +[Return to the **Optimised Software list**](../../dietpi_optimised_software) + diff --git a/docs/software/hardware_projects.md b/docs/software/hardware_projects.md index 5f82dfc3d..76db03a9c 100644 --- a/docs/software/hardware_projects.md +++ b/docs/software/hardware_projects.md @@ -19,4 +19,5 @@ - [InfluxDB - Database optimized to save time based data as logs or data from a sensor.](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=120#p12523) - [Grafana - The open platform for beautiful analytics and monitoring.](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=130#p12524) -[Return to the **Optimised Software list**](../dietpi_optimised_software) +[Return to the **Optimised Software list**](../../dietpi_optimised_software) + diff --git a/docs/software/home_automation.md b/docs/software/home_automation.md index f9bd1cd35..5cd0caea3 100644 --- a/docs/software/home_automation.md +++ b/docs/software/home_automation.md @@ -10,4 +10,4 @@ - [EmonPi - Lightweight Energy usage stats with EmonPi PCB.](https://dietpi.com/phpbb/viewtopic.php?p=1529#p1525) - [Grasshopper - Web App to control Bticino MyHome](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=20#p70) -[Return to the **Optimised Software list**](../dietpi_optimised_software) +[Return to the **Optimised Software list**](../../dietpi_optimised_software) diff --git a/docs/software/load_balancer.md b/docs/software/load_balancer.md index edc9aa388..72dc1e927 100644 --- a/docs/software/load_balancer.md +++ b/docs/software/load_balancer.md @@ -8,5 +8,5 @@ - [HAProxy - High performance TCP/HTTP load balancer.](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=30#p221) -[Return to the **Optimised Software list**](../dietpi_optimised_software) +[Return to the **Optimised Software list**](../../dietpi_optimised_software) diff --git a/docs/software/log_system.md b/docs/software/log_system.md index 3f44df275..a0c74d501 100644 --- a/docs/software/log_system.md +++ b/docs/software/log_system.md @@ -9,5 +9,5 @@ - [DietPi-RAMlog - Lightweight RAM logging.](https://dietpi.com/phpbb/viewtopic.php?p=68#p68) - [Full - Full logging system with Rsyslog and Logrotate.](https://dietpi.com/phpbb/viewtopic.php?p=68#p68) -[Return to the **Optimised Software list**](../dietpi_optimised_software) +[Return to the **Optimised Software list**](../../dietpi_optimised_software) diff --git a/docs/software/media.md b/docs/software/media.md index e6e49791f..d302b78e1 100644 --- a/docs/software/media.md +++ b/docs/software/media.md @@ -34,4 +34,4 @@ - [Ubooquity - Free home server for your comics and ebooks library](https://dietpi.com/phpbb/viewtopic.php?p=12969#p12969) - [Komga - Free and open source comics/mangas media server with web UI](https://dietpi.com/phpbb/viewtopic.php?p=26858#p26858) -[Return to the **Optimised Software list**](../dietpi_optimised_software) +[Return to the **Optimised Software list**](../../dietpi_optimised_software) diff --git a/docs/software/printing.md b/docs/software/printing.md index 975d360d7..f761e6669 100644 --- a/docs/software/printing.md +++ b/docs/software/printing.md @@ -9,4 +9,4 @@ - [CloudPrint - CUPS print server, with support for Google cloud printing](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=100#p6630) - [OctoPrint - Web interface for controlling 3D printers](https://dietpi.com/phpbb/viewtopic.php?p=7958#p7958) -[Return to the **Optimised Software list**](../dietpi_optimised_software) +[Return to the **Optimised Software list**](../../dietpi_optimised_software) diff --git a/docs/software/remote_desktop.md b/docs/software/remote_desktop.md index 1027042fc..14c32e52b 100644 --- a/docs/software/remote_desktop.md +++ b/docs/software/remote_desktop.md @@ -15,7 +15,7 @@ - [Remot3.it - (Weaved) Access your device over the internet.](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=20#p188) - [VirtualHere - Share physically attached USB devices from your SBC, over the network.](https://dietpi.com/phpbb/viewtopic.php?p=6709#p6709) -[Return to the **Optimised Software list**](../dietpi_optimised_software) +[Return to the **Optimised Software list**](../../dietpi_optimised_software) ??? info "How do I run **DietPi-Software** and install **Optimised software** ?" To install any of the **DietPi Optimised Software** listed below run from the command line: diff --git a/docs/software/social.md b/docs/software/social.md index 3aa03d6a8..8eb109a98 100644 --- a/docs/software/social.md +++ b/docs/software/social.md @@ -14,4 +14,5 @@ - [OpenBazaar - Decentralized peer to peer market server using BitCoin.](https://dietpi.com/phpbb/viewtopic.php?p=1796#p1796) - [YaCy - Decentralized open source search engine.](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=90#p6202) -[Return to the **Optimised Software list**](../dietpi_optimised_software) +[Return to the **Optimised Software list**](../../dietpi_optimised_software) + diff --git a/docs/software/ssh.md b/docs/software/ssh.md index a7d76b4a8..b6d94d8e9 100644 --- a/docs/software/ssh.md +++ b/docs/software/ssh.md @@ -5,7 +5,7 @@ - [Dropbear - Lightweight SSH Server](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=10#p62) - [OpenSSH - Feature rich SSH server with SFTP/SCP support.](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=10#p63) -[Return to the **Optimised Software list**](../dietpi_optimised_software) +[Return to the **Optimised Software list**](../../dietpi_optimised_software) !!! warning "Documentation in progress..." diff --git a/docs/software/system_security.md b/docs/software/system_security.md index cef4e47d8..ef1bfa0dc 100644 --- a/docs/software/system_security.md +++ b/docs/software/system_security.md @@ -5,7 +5,7 @@ - [Fail2Ban - Protects your system from brute-force attacks](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=30#p452) - [Docker - Build, ship, and run distributed applications](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=110#p9120) -[Return to the **Optimised Software list**](../dietpi_optimised_software) +[Return to the **Optimised Software list**](../../dietpi_optimised_software) !!! warning "Documentation in progress..." diff --git a/docs/software/system_stats.md b/docs/software/system_stats.md index fc2004272..31380a467 100644 --- a/docs/software/system_stats.md +++ b/docs/software/system_stats.md @@ -10,7 +10,7 @@ - [NetData - Web interface system stats](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=60#p1611) - [Webmin - Remote system management with web interface](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=80#p3047) -[Return to the **Optimised Software list**](../dietpi_optimised_software) +[Return to the **Optimised Software list**](../../dietpi_optimised_software) !!! warning "Documentation in progress..." diff --git a/docs/software/vpn.md b/docs/software/vpn.md index 720663adb..6e4e0ba08 100644 --- a/docs/software/vpn.md +++ b/docs/software/vpn.md @@ -7,7 +7,7 @@ - [PiVPN - OpenVPN server installer & management tool](https://dietpi.com/phpbb/viewtopic.php?p=3469#p3469) - [WireGuard - An extremely simple yet fast and modern VPN](https://dietpi.com/phpbb/viewtopic.php?p=16308#p16308) -[Return to the **Optimised Software list**](../dietpi_optimised_software) +[Return to the **Optimised Software list**](../../dietpi_optimised_software) !!! warning "Documentation in progress..." diff --git a/docs/software/webserver_stack.md b/docs/software/webserver_stack.md index ff99557a2..37bd8c34a 100644 --- a/docs/software/webserver_stack.md +++ b/docs/software/webserver_stack.md @@ -18,7 +18,7 @@ - [Nginx - Lightweight webserver](https://dietpi.com/phpbb/viewtopic.php?p=1549#p1549) - [Lighttpd - Extremely lightweight webserver](https://dietpi.com/phpbb/viewtopic.php?p=1549#p1549) -[Return to the **Optimised Software list**](../dietpi_optimised_software) +[Return to the **Optimised Software list**](../../dietpi_optimised_software) !!! warning "Documentation in progress..." diff --git a/docs/software/wifi_hotspot.md b/docs/software/wifi_hotspot.md index e7ba78375..02a88115c 100644 --- a/docs/software/wifi_hotspot.md +++ b/docs/software/wifi_hotspot.md @@ -5,7 +5,7 @@ - [WiFi HotSpot - Turn your device into a wireless hotspot/access point.](https://dietpi.com/phpbb/viewtopic.php?p=1207#p1207) - [Tor HotSpot - Optional: Routes all WiFi HotSpot traffic through the Tor network.](https://dietpi.com/phpbb/viewtopic.php?p=1529#p1529) -[Return to the **Optimised Software list**](../dietpi_optimised_software) +[Return to the **Optimised Software list**](../../dietpi_optimised_software) !!! warning "Documentation in progress..." From bb86b61466bab20c694287db1d3ffd3dc136280c Mon Sep 17 00:00:00 2001 From: StephanStS <57687516+StephanStS@users.noreply.github.com> Date: Sun, 11 Oct 2020 22:22:22 +0200 Subject: [PATCH 13/14] Update DietPi-Docs_Todo.md --- DietPi-Docs_Todo.md | 50 ++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 45 insertions(+), 5 deletions(-) diff --git a/DietPi-Docs_Todo.md b/DietPi-Docs_Todo.md index 411971d40..c83e9d449 100644 --- a/DietPi-Docs_Todo.md +++ b/DietPi-Docs_Todo.md @@ -29,7 +29,7 @@ Style Guide: _.md, e.g. user-guide_install.md. ToDo: Change file names initially. Remark: Google search should be considered. -**ToDo: Petru** +**ToDo: Petru** (done) ### 2.2 File structure @@ -40,7 +40,7 @@ Could this lead to problems when chapters or images are used several times? Open point, has to be cleared. -**ToDo: Petru** +**ToDo: Petru** (done) @@ -75,6 +75,8 @@ Below the tab area the *First boot on DietPi* section is located. Shall be moved to *Getting started*. +**ToDo Stephan:** Move contents. + *Getting started* shall contain often used procedures. Seldom used procedures shall be in *Advanced configuration & DietPi tools*. @@ -91,10 +93,14 @@ Harmonize/rearrange order in all sub-chapters: - Link table to images +**ToDo Stephan:** Harmonize sections. + ### 4.2 Supported Single Board Computers (SBCs) 1. Move *NanoPi Series (FriendlyARM)* below *ASUS Tinker Board* +**ToDo Stephan:** Change order. + ### 4.3 Description of DietPi PREP? 1. Q: Shall we describe this issue in a comprehensive form? @@ -102,10 +108,15 @@ Harmonize/rearrange order in all sub-chapters: Actually it is only referenced at the end of the [*Supported SBC* section](https://dietpi.com/docs/hardware-supported_sbc/#make-your-own-distribution). +**ToDo Stephan:** Make a proposal with some more screenshots. +Basically use *master* branch, use *dev* for hardening/testing Micha's PREP-script. + ### 4.4 Name of .md file 1. Q: Rename *hardware-supported_sbc.md* to *user-guide_supported_sbc.md* +**Done** with renaming/restructuring from Petru. + ### 4.5 Images Add images for @@ -114,27 +125,42 @@ Add images for The images are available on Dietpi.com\Download. +**ToDo Stephan:** Add images. + ## 5. Desktops Desktop basics (https://dietpi.com/docs/dietpi-software-desktop/): 1. Add a section how to setup the ***Autostart options*** via ***dietpi-config*** to start with LightDM - Have it similar to the collapsable description *How do I run DietPi-Software and install Optimised software ?* +**No extra description, because this is already described in the tab page *Enable autostart*.** + LXQt (https://dietpi.com/docs/dietpi-software-desktop/#lxqt-optimized-lightweight-desktop): 1. Add screenshot of desktop +**ToDo Stephan:** Add image. + + ## 6. DietPi Tools See there: https://dietpi.com/docs/user-guide_tools/ 1. Add a screenshot for *Software Additional* +**Todo Stephan:** +- Move dietpi-software main menu screenshot above the tabs selection +- Add a screenshot for *Software Additional* within the corresponding tab section + + ## 7. Description of Webserver stacks See there: https://dietpi.com/docs/dietpi-software-webserver-stack/ -1. Add a section how to select the webservers stacks via ***dietpi-software*** -2. Section [Webservers](https://dietpi.com/docs/dietpi-software-webserver-stack/#webservers): Exchange the three bullets with the description "behind the links" ([*Webserver Preference System*](https://dietpi.com/phpbb/viewtopic.php?p=1549#p1549)) - +1. 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). +2. Section [Webservers](https://dietpi.com/docs/dietpi-software-webserver-stack/#webservers): Exchange the three bullets with the description "behind the links" ([*Webserver Preference System*](https://dietpi.com/phpbb/viewtopic.php?p=1549#p1549)): + - Remove the links, but keep the three bullets + - Port the description *Webserver Preference System* to this section +3. How to port the stack description to the Webserver stacks section? Idea: + - Divide the description into sections about webservers, about data bases and about PHP. ## 8. Links *Return to the Optimised Software list* @@ -142,6 +168,9 @@ See there: https://dietpi.com/docs/dietpi-software-webserver-stack/ At the bottom there is a link to jump back. Q: Is this linking done in all necessary pages? If no, where should it be inserted? +**Already done in this way.** + + ## 9. Gitea software ### 9.1 Prerequisites @@ -153,3 +182,14 @@ Describe/check user rights of dietpi user and letsencrypt. - Describe combination Gitea and letsencrypt. Then use https for access. +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 + + +## 10. Backup/Restore +Describe Backup/Restore: +- via dietpi-backup +- via different/other backup solutions + E.g. see https://www.linuxlinks.com/backup/ From 3394fe1a689060b70117dcb1186388f5bf43e86b Mon Sep 17 00:00:00 2001 From: fpetru Date: Sun, 11 Oct 2020 22:58:14 +0200 Subject: [PATCH 14/14] more changes --- .../dietpi_docs_todo.md | 63 ++++++++++--------- docs/user-guide_install_uefi.md | 16 ++--- docs/user-guide_install_virtualbox.md | 12 ++-- mkdocs.yml | 1 + 4 files changed, 49 insertions(+), 43 deletions(-) rename DietPi-Docs_Todo.md => docs/dietpi_docs_todo.md (76%) diff --git a/DietPi-Docs_Todo.md b/docs/dietpi_docs_todo.md similarity index 76% rename from DietPi-Docs_Todo.md rename to docs/dietpi_docs_todo.md index 411971d40..12ee9b717 100644 --- a/DietPi-Docs_Todo.md +++ b/docs/dietpi_docs_todo.md @@ -1,5 +1,4 @@ -# DietPi-Docs Ideas - +# Documentation Ideas & Tasks ## 1. Development general @@ -17,20 +16,26 @@ Committing changes from the private fork branch to the dev branch on Micha's rep Merging should be done via 4-eyes method when merging to the master branch. +- [x] Rules are now enabled. ## 2. Files general ### 2.1 Filenames .md -Some of the filenames use '-', others use '_'. -E.g. dietpi-software-bittorrent.md vs. user-guide_install.md. -I would prefer the latter one: _.md. -Style Guide: _.md, e.g. user-guide_install.md. + - Some of the filenames use '-', others use '_'. + e.g. dietpi-software-bittorrent.md vs. user-guide_install.md. + I would prefer the latter one: `_.md`. + + **Style Guide**: + ``` + _.md, all lower case + Example: user-guide_install.md. + ``` + ToDo: Change file names initially. Remark: Google search should be considered. -**ToDo: Petru** - +- [x] Petru to enable the new naming rules ### 2.2 File structure Q: Shall we structure every chapter to subdirs (with own assets sub-subdirs)? @@ -40,21 +45,21 @@ Could this lead to problems when chapters or images are used several times? Open point, has to be cleared. -**ToDo: Petru** - - - +- [x] Petru to enable new file structure ## 3. Installation chapter ### 3.1 Docu structure + Today: -- Installation (*covers SBC installation* and *First boot on DietPi*) -- Advanced installation - - Install DietPi on native PC - - Install DietPi as an Oracle VirtualBox machine + + - Installation (*covers SBC installation* and *First boot on DietPi*) + - Advanced installation + - Install DietPi on native PC + - Install DietPi as an Oracle VirtualBox machine Proposal: -- **Installation** (*covers overview over several options: SBC, PC, virtual machine*) + + - **Installation** (*covers overview over several options: SBC, PC, virtual machine*) - **Installation on SBC** ([contents](https://dietpi.com/docs/user-guide_install/)) - **Installation on native PC** ([contents](https://dietpi.com/docs/user-guide_install_uefi/)) - **Installation on VirtualBox machine** ([contents](https://dietpi.com/docs/user-guide_install_VirtualBox/)) @@ -62,33 +67,33 @@ Proposal: - **First boot on DietPi** (move this from the [*Installation on SBC*](https://dietpi.com/docs/user-guide_install/#3-first-boot-on-dietpi) section to here) -Idea: Use tabs in the content area (like there: https://dietpi.com/docs/dietpi-software-desktop/#lxde-ultra-lightweight-desktop) to distinguish between SBC, native PC, VirtualBox,etc. -Below the tab area the *First boot on DietPi* section is located. - -**ToDo Stephan:** Implement the changed *Installation* structure. - +Idea: + - Use tabs in the content area (like there: https://dietpi.com/docs/dietpi-software-desktop/#lxde-ultra-lightweight-desktop) to distinguish between SBC, native PC, VirtualBox,etc. Below the tab area the *First boot on DietPi* section is located. +- [ ] **ToDo Stephan:** Implement the changed *Installation* structure. ### 3.2 Description of *dietpi-software* usage -1. Move [4. Install software with the DietPi-Software tool](https://dietpi.com/docs/user-guide_install/#4-install-software-with-the-dietpi-software-tool) to [DietPi Optimised software Index](https://dietpi.com/docs/user-optimised-software/) ? + + 1. Move [4. Install software with the DietPi-Software tool](https://dietpi.com/docs/user-guide_install/#4-install-software-with-the-dietpi-software-tool) to [DietPi Optimised software Index](https://dietpi.com/docs/user-optimised-software/) ? *dietpi-software* should not be a tool which is run only once during the installation. Shall be moved to *Getting started*. *Getting started* shall contain often used procedures. Seldom used procedures shall be in *Advanced configuration & DietPi tools*. - -# xxx go ahead here + - go ahead here ## 4 Supported Single Board Computers (SBCs) + See there: https://dietpi.com/docs/hardware-supported_sbc/. ### 4.1 Structure of chapters Harmonize/rearrange order in all sub-chapters: -- Heading -- Hardware description -- Picture of hardware -- Link table to images + + - Heading + - Hardware description + - Picture of hardware + - Link table to images diff --git a/docs/user-guide_install_uefi.md b/docs/user-guide_install_uefi.md index fc8fa4684..47a7f4ad4 100644 --- a/docs/user-guide_install_uefi.md +++ b/docs/user-guide_install_uefi.md @@ -1,19 +1,19 @@ --- -description: DietPi installation on native PC +description: DietPi installation on native PC using UEFI title: How to install DietPi on native PC --- # How to install DietPi on native PC (with UEFI) -## 1. Intro +## Introduction -The Native PC images are great for those occasions where SBC performance just isn’t enough. One example could be [Intel NUC Kit](https://www.intel.com/content/www/us/en/products/boards-kits/nuc/kits.html?page=2). It is a small, versatile, upgradable, and affordable desktop PC with the same basic feature set as that of a much larger machine. +The Native PC images are great for those occasions where SBC performance is just not enough. One example could be [Intel NUC Kit](https://www.intel.com/content/www/us/en/products/boards-kits/nuc/kits.html?page=2). It is a small, versatile, upgradable, and affordable desktop PC with the same basic feature set as that of a much larger machine. ![DietPi-Intel-NUC](assets/images/dietpi-nuc8.jpg) It could be also a great way to make use of an old computer that’s not capable of running the latest version of Windows or macOS. -## 2. Prerequisites +### Prerequisites You would need the next: - one **working PC with internet access**, helping to flash the boot media @@ -23,7 +23,7 @@ You would need the next: !!! warning "All data on the USB medium and on the target PCs harddisk will be erased !" Before starting the installation make first backup of the data available on the target PC and USB drive ! -## 3. Download and extract the DietPi disk image +## 1. Download and extract the DietPi disk image Download the **DietPi installer image** from [dietpi.com](https://dietpi.com/#download) and unzip the downloaded file to a local folder. It is a _7z_ archive format so you will need to install either [7zip for Windows](https://www.7-zip.org/) or other alternative tools. @@ -35,7 +35,7 @@ Download **[Rufus](https://rufus.ie/)** and run the application. There is a port !!! warning "Be careful if you run alternative applications !" While [Balena Etcher](https://www.balena.io/etcher/) is recommended for installing DietPi on SBCs, it does not provide good results for UEFI images. The same also with win32diskimager, which does not work as an alternative. -## 4. Flash image to USB drive +## 2. Flash image to USB drive Start **[Rufus](https://rufus.ie/)** application and make sure you have your USB drive inserted into your computer. Follow the next steps: @@ -49,7 +49,7 @@ Start **[Rufus](https://rufus.ie/)** application and make sure you have your USB ![dietpi-rufus-uefi](assets/images/dietpi-rufus-uefi.jpg) -## 5. Boot the target PC and install the image on the local disk +## 3. Boot the target PC and install the image on the local disk Boot the **target PC** from USB image and install the image on the local disk / harddisk. Put the USB stick into the target PC and boot from this USB stick _Note: it may be necessary to change BIOS settings to enable the UEFI boot. This action is not described here._ @@ -83,7 +83,7 @@ After this, the installation process starts with several steps, e.g. showing the These steps take some time, be patient ! Otherwise buy an SSD. :-) At the end the system executes a shutdown. -## 6. First boot of the target PC with DietPi +## 4. First boot of the target PC with DietPi At first disconnect your USB stick from the target PC. Then power on the PC. The system will boot up and do the DietPi installation. diff --git a/docs/user-guide_install_virtualbox.md b/docs/user-guide_install_virtualbox.md index 1a8ef69b6..aa541fa2c 100644 --- a/docs/user-guide_install_virtualbox.md +++ b/docs/user-guide_install_virtualbox.md @@ -1,11 +1,11 @@ --- description: DietPi installation as an Oracle VirtualBox machine -title: How to install DietPi as an Oracle VirtualBox machine +title: How to install DietPi as a VirtualBox machine --- # How to install DietPi as an Oracle VirtualBox machine -## 1. Intro +## Introduction Virtual machine images are great for those occasions where you want to set up a DietPi system very quickly and test things. Also it may be used as a debian based linux system with a small footprint for development purposes, e.g. with the X11 window system. The small footprint makes it optimally usable on PCs without a huge built in RAM. Also several VMs may be run for different applications. @@ -16,7 +16,7 @@ One of the options of a virtual machine is [__Oracle VirtualBox__](https://www.o ![DietPi-VirtualBox-program](assets/images/dietpi-VirtualBox-program.png) -## 2. Prerequisites +### Prerequisites As a starting point you need a **PC with a running VirtualBox software** on which the DietPi system will run. On this PC a free harddisk space of about @@ -25,7 +25,7 @@ On this PC a free harddisk space of about is needed. A recommended size is at least a free space of 10 GB. -## 3. Download and extract the DietPi disk image +## 1. Download and extract the DietPi disk image Download the **DietPi VirtualBox file** "DietPi_VirtualBox-x86_64-Buster.7z" from [dietpi.com](https://dietpi.com/#download) and unzip the downloaded file to a local folder. It is a _7z_ archive format so you will need to install either [7zip for Windows](https://www.7-zip.org/) or other alternative tools. @@ -37,7 +37,7 @@ The zip file contains a couple of files, the important one is the .ova file whic ![Dietpi-zipfile-content](assets/images/dietpi-VirtualBox-7zip-file.png) -## 4. Import of the .ova file in VirtualBox +## 2. Import of the .ova file in VirtualBox As next, the VirtualBox virtual machine has to be setup by importing the .ova file (via \File\Import Appliance): @@ -53,7 +53,7 @@ After the importing has finished the DietPi VirtualBox virtual machine is presen ![DietPi-VirtualBoxMachine1](assets/images/dietpi-VirtualBox-VB-Machine.png) -## 5. First boot of the new VirtualBox image +## 3. First boot of the new VirtualBox image Press the start button (green arrow) to 'boot up' your system based on the DietPi image. If you do not have a wired LAN connection you have to change the network settings matching to your environment (files ___\boot\dietpi.txt___ and ___\boot\dietpi-wifi.txt___). diff --git a/mkdocs.yml b/mkdocs.yml index 36af7ecb0..8c95ec859 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -130,6 +130,7 @@ nav: - 'Release notes' : 'release-notes.md' - 'Request features' : 'https://github.com/MichaIng/DietPi/issues/new/choose' - 'Report issues' : 'https://github.com/MichaIng/DietPi/issues' + - 'Documentation Tasks' : 'dietpi_docs_todo.md' - 'OPTIMISED SOFTWARE' : - 'Desktops & Utilities' : 'software/desktop.md' - 'Media Systems': 'software/media.md'