Merge pull request #96 from ThePorgs/dev

ShutdownRepo · web-flow · commit 2e6ffdcbda4b · 2025-09-19T22:41:22.000+02:00
Refactor on the nix wrapper install &amp; legal changes
diff --git a/docs/src/install/on-nixos.md b/docs/src/install/on-nixos.md
@@ -3,14 +3,21 @@
 > [!NOTE]
 > This page was brought to you by a community member and wasn't "mass-tested" yet. Feedback on whether it works properly (or not) would be greatly appreciated (please head over to our Discord server for that).
 
+> [!IMPORTANT]
+> This page focuses on the NixOS way (declarative and reproducible) and also documents an alternative with pipx. Because NixOS is all about reproducibility, the "nix way" comes first. Please note that the official and recommended way to install Exegol is over pipx. 
+
 Exegol is installed through two main steps:
 
 1. Install the Python wrapper (the "brains")
 2. Install at least one Exegol image (the "muscle")
 
-## 1. Requirements
+## 1. NixOS-native
 
-`git`, `python3`, `pipx`, and the Docker engine can be installed by editing your NixOS configuration:
+This approach keeps your system declarative and reproducible: all changes live in your Nix configuration.
+
+### Enable Docker & install Exegol
+
+`exegol` and the Docker engine can be installed by editing your NixOS configuration:
 
 ```bash
 sudo nano /etc/nixos/configuration.nix
@@ -19,15 +26,94 @@ sudo nano /etc/nixos/configuration.nix
 Add the following lines (or merge with your existing configuration):
 
 ```bash
-  environment.systemPackages = with pkgs; [
+environment.systemPackages = with pkgs; [
+  exegol
+];
+virtualisation.docker = {
+  enable = true;
+  # Do NOT enable rootless here — Exegol doesn’t support Docker rootless mode
+  rootless.enable = false; # (false is the default)
+};
+```
+
+To run Exegol without sudo, the user must be a member of the docker group. This can be declared in the NixOS configuration:
+```nix
+users.users.<user>.extraGroups = [ "docker" ];
+```
+
+> [!WARNING]
+> The exegol package in nixpkgs is not maintained by the Exegol team. Packaging issues should be reported to the `nixpkgs` maintainers. Questions may be asked on Discord, but support for this packaging path is provided on a best-effort basis.
+
+Save the file with [CTRL] + [O], press [ENTER], and exit with [CTRL] + [X]. Then rebuild your system:
+
+```bash
+sudo nixos-rebuild switch
+```
+
+> [!TIP]
+> Using flakes ? Add `pkgs.exegol` in the flake’s NixOS module in the same way, then:
+> ```bash
+> sudo nixos-rebuild switch --flake .#your-host
+> ```
+
+After rebuilding, log out and back in (or run newgrp docker) so the new group membership takes effect.
+
+### Need a newer Exegol wrapper via `nixpkgs`?
+
+From most stable to least stable option:
+
+1. A newer channel (e.g., `nixos-unstable`) can be used for just this package:
+  ```nix
+  let
+    unstable = import <nixos-unstable> { };
+  in {
+    environment.systemPackages = with pkgs; [
+      unstable.exegol
+    ];
+  }
+  ```
+  > The whole system can also be switched to `nixos-unstable`, but that affects everything.
+2. If the target version is not yet present in `nixpkgs`:
+  - The Exegol derivation can be copied from a PR or a staging branch into the configuration.
+  - Write your own derivation pointing to the desired source/version
+
+> [!NOTE]
+> Prefer these Nix-friendly options over [`pipx`](/install/on-nixos#_2-portable-alternative) only if you care about reproducibility. 
+
+### Next
+
+Once the wrapper and docker are installed, the main installation documentation can be followed, from [step "3. Activation"](/first-install#_3-activation).
+
+## 2. `pipx` alternative
+
+### Enable prerequisite
+
+If you need the very latest wrapper immediately and can accept a non-declarative/non-reproducible setup:
+
+`git`, `python3`, `pipx`, and the Docker engine can be installed by editing your NixOS configuration:
+
+```bash
+sudo nano /etc/nixos/configuration.nix
+```
+
+Add the following lines (or merge with your existing configuration):
+
+```nix
+environment.systemPackages = with pkgs; [
   git
   python3
   pipx 
- ];
-   virtualisation.docker = {
-    enable = true;
-  };
+];
+virtualisation.docker = {
+  enable = true;
+  # Do NOT enable rootless here — Exegol doesn’t support Docker rootless mode
+  rootless.enable = false; # (false is the default)
+};
+```
 
+To run Exegol without sudo, the user must be a member of the docker group. This can be declared in the NixOS configuration:
+```nix
+users.users.<user>.extraGroups = [ "docker" ];
 ```
 
 Save the file with [CTRL] + [O], press [ENTER], and exit with [CTRL] + [X].
@@ -38,18 +124,17 @@ Then apply the changes:
 sudo nixos-rebuild switch
 ```
 
-Ensure `pipx` is in PATH and reload the shell
+> [!TIP]
+> Using flakes ? Add `pkgs.git`, `pkgs.python3` and `pkgs.pipx` in the flake’s NixOS module in the same way, then:
+> ```bash
+> sudo nixos-rebuild switch --flake .#your-host
+> ```
 
+Ensure pipx is in PATH and reload the shell
 ```bash
 pipx ensurepath && exec $SHELL
 ```
 
-While we always advise to refer to the [official documentation](https://docs.docker.com/engine/install/)
-
-
-> [!WARNING]
-> Docker "[Rootless mode](https://docs.docker.com/engine/security/rootless/)" is not supported by Exegol as of yet. Don't follow that part.
-
-## 2. The rest
+### Next
 
 Once the requirements are installed, the main installation documentation can be followed, from [step "2. Wrapper install"](/first-install#_2-wrapper-install).
diff --git a/docs/src/legal/cookie-policy.md b/docs/src/legal/cookie-policy.md
@@ -63,4 +63,4 @@ We may update this cookie policy from time to time. Significant changes will be
 
 ## 6. Contact
 
-If you have questions about our cookie practices, please contact [contact@exegol.com](mailto:contact@exegol.com). 
+If you have questions about our cookie practices, please contact contact@exegol.com. 
diff --git a/docs/src/legal/eula.md b/docs/src/legal/eula.md
@@ -6,6 +6,8 @@ By downloading, installing, accessing, or using the Software, You agree to be bo
 
 If You do not agree to the terms of this Agreement, You must not use the Software.
 
+For open-source components, please also refer to the Exegol Software License (ESL) (https://docs.exegol.com/legal/software-license).
+
 ## 1. License grant
 
 Subject to Your compliance with this Agreement, Execorp grants You a personal, limited, non-exclusive, non-transferable, revocable license to install and use the Software solely:
@@ -28,12 +30,13 @@ This requirement may not apply to certain Enterprise licenses, on a case-by-case
 
 ## 2. License restrictions
 
-You agree that You will not:
+Except where expressly permitted by the Exegol Software License (ESL) (https://docs.exegol.com/legal/software-license), other applicable open-source licenses, or by law, you agree that you will not:
+
 - Copy, distribute, sell, sublicense, lease, or otherwise transfer the Software to any third party
-- Modify, adapt, create derivative works from, or translate the Software
+- Modify, adapt, create derivative works from, or translate the Software, except for personal use or community contribution, provided such modification is not intended to circumvent license verification or other technical restrictions; any commercial use of modifications is only permitted in accordance with your subscription plan (Pro or Enterprise) and is subject to this Agreement, the [Terms of Sale](https://docs.exegol.com/legal/terms-of-sale), and the [Terms of Service](https://docs.exegol.com/legal/terms-of-service); any form of commercial exploitation (such as reselling, providing managed services, or repackaging for third parties) is strictly prohibited without a separate written agreement with Execorp.
 - Reverse engineer, decompile, disassemble, or otherwise attempt to discover the source code of the Software, except as expressly permitted by applicable law and then only after prior written notice to Execorp
 - Remove, obscure, or alter any proprietary notices, labels, or marks on the Software
-- Use the Software for illegal activities or unauthorized penetration testing without explicit consent
+- Use the Software for illegal activities
 - Use the Software in any manner that infringes the intellectual property rights or other rights of Execorp or any third party
 
 ## 3. Commercial use
@@ -52,6 +55,12 @@ All rights, titles, and interests in and to the Software, including any intellec
 
 This Agreement does not grant You any rights to trademarks or service marks of Execorp.
 
+### 4.1 Open-source components
+
+Certain components of the Software may be open-source and subject to additional licensing terms, including the Exegol Software License (ESL) (https://docs.exegol.com/legal/software-license) and, where applicable, the GNU General Public License version 3 (GPL3). You must comply with all applicable open-source licenses in addition to this EULA.
+
+For open-source components, the terms of the applicable open-source license take precedence over conflicting terms in this EULA, except for commercial use restrictions which remain subject to our Terms of Service and Sale, and commercial exploitation which is strictly prohibited without a separate written agreement with Execorp.
+
 ## 5. Updates and modifications
 
 Execorp may, at its sole discretion, release updates, patches, or new versions of the Software.
@@ -92,4 +101,4 @@ Any dispute arising out of or related to this Agreement will be submitted to the
 
 ## 10. Contact
 
-For any inquiries related to this Agreement or the Software, You may contact: [contact@exegol.com](mailto:contact@exegol.com) 
+For any inquiries related to this Agreement or the Software, You may contact contact@exegol.com 
diff --git a/docs/src/legal/legal-notice.md b/docs/src/legal/legal-notice.md
@@ -2,17 +2,17 @@
 
 ## 1. Website publisher
 
-The website [https://exegol.com](https://exegol.com) and all its subdomains are published by Execorp, a Simplified Joint Stock Company (SAS) with a capital of 10,000 euros, registered in the "Tribunal des Activités Économiques de Paris" under SIREN number 944 256 536. Registered office: 122 rue Amelot, 75011 Paris, France. Contact email: [contact@exegol.com](mailto:contact@exegol.com)
+The website https://exegol.com and all its subdomains are published by Execorp, a Simplified Joint Stock Company (SAS) with a capital of 10,000 euros, registered in the "Tribunal des Activités Économiques de Paris" under SIREN number 944 256 536. Registered office: 122 rue Amelot, 75011 Paris, France. Contact email: contact@exegol.com
 
 ## 2. Publishing director
 
 The publishing director is the President of Execorp, namely MONKEY 513, a Single-Person Simplified Joint Stock Company (SASU), registered under SIREN number 932 547 367, with its registered office at 122 rue Amelot, 75011 Paris, France.
 
 ## 3. Hosting
 
-The website [https://exegol.com](https://exegol.com) and all its subdomains are primarily hosted by Cloudflare, Inc., 101 Townsend St, San Francisco, CA 94107, United States. Website: [https://www.cloudflare.com](https://www.cloudflare.com)
+The website https://exegol.com and all its subdomains are primarily hosted by Cloudflare, Inc., 101 Townsend St, San Francisco, CA 94107, United States. Website: www.cloudflare.com.
 
-Certain data, particularly user databases, are stored by Supabase, Inc., 970 Toa Payoh North, #07-04, Singapore 318992. Website: [https://supabase.com](https://supabase.com). The database itself is in France.
+Certain data, particularly user databases, are stored by Supabase, Inc., 970 Toa Payoh North, #07-04, Singapore 318992. Website: https://supabase.com. The database itself is in France.
 
 ## 4. Intellectual property
 
diff --git a/docs/src/legal/open-source-components.md b/docs/src/legal/open-source-components.md
@@ -8,25 +8,25 @@ The following is a non-exhaustive list of the primary open source components use
 
 ### 1.1 Core technologies
 
-- **Docker**: [Apache License 2.0](https://github.com/moby/moby/blob/master/LICENSE)
-- **Python**: [Python Software Foundation License](https://docs.python.org/3/license.html)
-- **Debian**: [Various licenses](https://www.debian.org/legal/licenses/)
+- **Docker**: Apache License 2.0 (https://github.com/moby/moby/blob/master/LICENSE)
+- **Python**: Python Software Foundation License (https://docs.python.org/3/license.html)
+- **Debian**: Various licenses (https://www.debian.org/legal/licenses/)
 
 ### 1.2 Web and frontend components
 
-- **React**: [MIT License](https://github.com/facebook/react/blob/main/LICENSE)
-- **NextJS**: [MIT License](https://github.com/vercel/next.js/blob/canary/license.md)
-- **Tailwind CSS**: [MIT License](https://github.com/tailwindlabs/tailwindcss/blob/master/LICENSE)
+- **React**: MIT License (https://github.com/facebook/react/blob/main/LICENSE)
+- **NextJS**: MIT License (https://github.com/vercel/next.js/blob/canary/license.md)
+- **Tailwind CSS**: MIT License (https://github.com/tailwindlabs/tailwindcss/blob/master/LICENSE)
 
 ### 1.3 Backend and infrastructure
 
-- **Supabase**: [Apache License 2.0](https://github.com/supabase/supabase/blob/master/LICENSE)
-- **PostgreSQL**: [PostgreSQL License](https://www.postgresql.org/about/licence/)
-- **Nginx**: [BSD 2-Clause License](https://nginx.org/LICENSE)
+- **Supabase**: Apache License 2.0 (https://github.com/supabase/supabase/blob/master/LICENSE)
+- **PostgreSQL**: PostgreSQL License (https://www.postgresql.org/about/licence/)
+- **Nginx**: BSD 2-Clause License (https://nginx.org/LICENSE)
 
 ### 1.4 Security tools and libraries
 
-For a complete and up-to-date list of security tools included in Exegol, please refer to [the tools list](/images/tools).
+For a complete and up-to-date list of security tools included in Exegol, please refer to the tools list at [https://docs.exegol.com/images/tools](/images/tools).
 
 ## 2. License compliance
 
@@ -41,7 +41,7 @@ Execorp strives to ensure compliance with all open source licenses. This include
 
 The complete license texts for the above components can be found in their respective repositories or websites.
 
-If you believe any component is not properly attributed or is used in a way that violates its license terms, please contact us at [contact@exegol.com](mailto:contact@exegol.com).
+If you believe any component is not properly attributed or is used in a way that violates its license terms, please contact us at contact@exegol.com.
 
 ## 4. Contributing to open source
 
diff --git a/docs/src/legal/privacy-policy.md b/docs/src/legal/privacy-policy.md
@@ -4,7 +4,7 @@
 
 The data controller for the data collected on exegol.com and its subdomains is:
 Execorp, SAS with a capital of 10,000 euros, whose registered office is located at 122 rue Amelot, 75011 Paris, France.
-Contact email: [contact@exegol.com](mailto:contact@exegol.com)
+Contact email: contact@exegol.com
 
 ## 2. Data collected
 
@@ -71,7 +71,7 @@ In accordance with applicable regulations, users have the following rights:
 - Right to restriction of processing
 - Right to data portability
 
-To exercise these rights, users can send a request to: [contact@exegol.com](mailto:contact@exegol.com)
+To exercise these rights, users can send a request to: contact@exegol.com
 
 ## 10. Data breach notification
 
@@ -93,7 +93,7 @@ We will communicate through email, account notifications, or other direct means
 ## 11. GDPR compliance
 
 Execorp processes personal data in accordance with the General Data Protection Regulation (GDPR - Regulation (EU) 2016/679).
-Users also have the right to lodge a complaint with the competent supervisory authority, the CNIL (Commission Nationale de l'Informatique et des Libertés), accessible via the website: [www.cnil.fr](https://www.cnil.fr).
+Users also have the right to lodge a complaint with the competent supervisory authority, the CNIL (Commission Nationale de l'Informatique et des Libertés), accessible via the website www.cnil.fr.
 
 ## 12. Modifications
 
diff --git a/docs/src/legal/security-policy.md b/docs/src/legal/security-policy.md
@@ -31,7 +31,7 @@ The following is a non-exhaustive list of examples considered out of scope:
 
 ## 3. How to report a vulnerability
 
-Please contact us primarily through our dedicated email address: [contact@exegol.com](mailto:contact@exegol.com)
+Please contact us primarily through our dedicated email address: contact@exegol.com
 
 When reporting, please:
 - Provide a clear description of the issue
diff --git a/docs/src/legal/software-license.md b/docs/src/legal/software-license.md
@@ -2,15 +2,15 @@
 
 ## Preamble
 
-The Exegol software suite ("Exegol") is developed by Execorp to serve the needs of cybersecurity professionals. While certain elements of the source code, scripts, documentation, or containers may be made publicly accessible, such availability is intended to foster transparency, community trust, and collaboration.
+The Exegol software suite ("Exegol") is developed by Execorp, with valuable contributions from the community, to serve the needs of cybersecurity professionals. While certain elements of the source code, scripts, documentation, or containers may be made publicly accessible, such availability is intended to foster transparency, community trust, and collaboration.
 
 This public access does not imply a waiver of Execorp's intellectual property rights, nor does it authorize unrestricted or commercial use of the software.
 
 ### License Transition and GPL3 Coexistence
 
 Exegol is transitioning from the GNU General Public License version 3 (GPL3) to the Execorp Software License (ESL). This transition is governed by the following rules:
 
-- All code released prior to June 5th, 2025 remains under GPL3 (i.e., [GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007](https://www.gnu.org/licenses/gpl-3.0.en.html))
+- All code released prior to June 5th, 2025 remains under GPL3 (i.e., GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 - https://www.gnu.org/licenses/gpl-3.0.en.html)
 - Code released since June 5th, 2025 (the start date of this dual-license mechanism) will be under either:
   - The Exegol Software License (ESL)
   - or GPL3 (if it contains or is derived from GPL3-licensed code)
diff --git a/docs/src/legal/summary.md b/docs/src/legal/summary.md
diff --git a/docs/src/legal/terms-of-service.md b/docs/src/legal/terms-of-service.md
diff --git a/docs/src/troubleshooting.md b/docs/src/troubleshooting.md

Original file line number	Diff line number	Diff line change
`@@ -63,4 +63,4 @@ We may update this cookie policy from time to time. Significant changes will be`
`63`	`63`
`64`	`64`	`## 6. Contact`
`65`	`65`
`66`		`-If you have questions about our cookie practices, please contact [contact@exegol.com](mailto:contact@exegol.com).`
	`66`	`+If you have questions about our cookie practices, please contact contact@exegol.com.`