truecharts/charts/stable/docusaurus/docs/How-To.md at d770fdf7993d02aef00a8c6dd0045d589816e9e9

Files

T

gismo2004 1ad44a371d docs(docusaurus) update how-to (#32293 )

**Description**

Update docs and remove scale references.

⚒️ Fixes  # <!--(issue)-->

**⚙️ Type of change**

- [ ] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] 🔃 Refactor of current code
- [x] 📜 Documentation Changes

**🧪 How Has This Been Tested?**
<!--
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration
-->

**📃 Notes:**
<!-- Please enter any other relevant information here -->

**✔️ Checklist:**

- [ ] ⚖️ My code follows the style guidelines of this project
- [x] 👀 I have performed a self-review of my own code
- [ ] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [ ] 📄 I have made changes to the documentation
- [ ] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [ ] ⬆️ I increased versions for any altered app according to semantic
versioning
- [ ] I made sure the title starts with `feat(chart-name):`,
`fix(chart-name):`, `chore(chart-name):`, `docs(chart-name):` or
`fix(docs):`

**➕ App addition**

If this PR is an app addition please make sure you have done the
following.

- [ ] 🖼️ I have added an icon in the Chart's root directory called
`icon.png`

---

_Please don't blindly check all the boxes. Read them and only check
those that apply.
Those checkboxes are there for the reviewer to see what is this all
about and
the status of this PR with a quick glance._

---------

Signed-off-by: Alfred Göppel <43101280+alfi0812@users.noreply.github.com>
Co-authored-by: Alfred Göppel <43101280+alfi0812@users.noreply.github.com>

2025-02-20 16:54:05 +00:00

1.9 KiB

Raw Blame History

title

title
How-To

This is a quick setup-guide to run Docusaurus on your own server.

Requirements

None necessary, a domain name is recommended for usage but not required.

Docusaurus Chart Setup

Environment variables

WEBSITE_NAME: Your website name
TEMPLATE: Docusaurus Default Template is generally classic unless you've manually installed another
RUN_MODE: Choose between production and development mode

workload:
  main:
    podSpec:
      containers:
        main:
          env:
            WEBSITE_NAME: "Docusaurus HomeLab Website"
            TEMPLATE: classic
            RUN_MODE: development

Storage and Persistance

This chart uses PVC for storage, as do most of our charts. However, some users may need to frequently edit certain files or directories. A simple way to edit files inside the container is by using our CodeServer Add-on. It provides a web-based file editor and is intended for temporary use, allowing you to add or remove it at any time.

While it is possible to mount a specific folder to an external storage location, such as an NFS share, this approach is not recommended as it adds complexity. By default, the PVC mounts /docusaurus, meaning all files in /docusaurus/website/docs are stored within the PVC. If you choose to mount an external share, you must ensure that the required files are manually placed in the new location, as they will not be copied over automatically.

persistence:
  docs:
    enabled: true
    type: nfs
    path: ${NFS_PATH}
    server: ${SERVER_IP}
    mountPath: /docusaurus/website/docs

Support

If you need more details or have a more customized setup, the documentation on the upstream repository is very comprehensive. Check the descriptions of the available options there for further guidance.

1.9 KiB Raw Blame History