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

Files

Stavros Kois 698622495c chore(docs): standardize ./img references (#16704 )

**Description**
<!--
Please include a summary of the change and which issue is fixed. Please
also include relevant motivation and context. List any dependencies that
are required for this change.
-->
⚒️ 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

**🧪 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
- [ ] 👀 I have performed a self-review of my own code
- [ ] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [ ] 📄 I have made corresponding changes to the documentation
- [ ] ⚠️ My changes generate no new warnings
- [ ] 🧪 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

**➕ App addition**

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

- [ ] 🪞 I have opened a PR on
[truecharts/containers](https://github.com/truecharts/containers) adding
the container to TrueCharts mirror repo.
- [ ] 🖼️ 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._

2023-12-31 22:39:31 +02:00

1.9 KiB

Raw Blame History

title

title
How-To

This is a quick how-to or setup-guide to run Docusaurus on your own server. This can be applied to other systems but this specific guide is made on TrueNAS SCALE and screenshots are provided from that system.

Requirements

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

Docusaurus Chart Setup

Container Configuration

Enter Docusaurus or Website Name
Docusaurus Default Template is generally classic unless you've manually installed another
Choose Production mode or Development mode

Networking and Services

Leave defaults unless using Ingress then ClusterIP is recommended

Storage and Persistance

This chart uses PVC for storage as most of our charts do for Storage. However some may want to edit certain files or directories more often. This can be done with Configure Additional Storage.
- Click Add under Configure App Additional Storage
- Add the Host Path of the folder you wish to use
- Use the Mount Path of the folder you wish to have accessible. For example /docusaurus/website/docs mounts the files inside the /docs of the standard Docusaurus website.

Ingress

Recommended for use with a domain name but not required as mentioned above. You can refer to our Quick-Start Guides for an overview on using Ingress with your chart.

Support

If you need more details or have a more custom setup the documentation on the upstream is very complete so check the descriptions of the options there.
You can also reach us using Discord for real-time feedback and support
If you found a bug in our chart, open a Github issue

1.9 KiB Raw Blame History