Skip to content

Commit a1fda7d

Browse files
committed
docs: migrate UNIT to hugo and documentation repo
1 parent e85ddd9 commit a1fda7d

File tree

147 files changed

+22017
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

147 files changed

+22017
-1
lines changed

config/_default/config.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@ enableGitInfo = true
4444
"taxonomyTerm"
4545
]
4646
taxonomiesExcludedFromSitemap = ["tags", "categories", "doctypes"]
47-
47+
unitversion= "1.34.1"
48+
unitversionv= "v1.34.1"
4849
#logo = ""
4950

5051
# Version lists; used by the versions shortcode
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Run the following command (as root) so Unit can access the application
2+
directory (If the application uses several directories, run the command for
3+
each one):
4+
5+
```console
6+
# chown -R unit:unit /path/to/app/ # User and group that Unit's router runs as by default
7+
```
8+
9+
10+
{{< note >}}
11+
The **unit:unit** user-group pair is available only with
12+
[official packages]({{< relref "/unit/installation.md#installation-precomp-pkgs" >}})
13+
, Docker [images]({{< relref "/unit/installation.md#installation-docker" >}}),
14+
and some [third-party repos]({{< relref "/unit/installation.md#installation-community-repos" >}}). Otherwise, account names may differ; run the `ps aux | grep unitd` command to be sure.
15+
{{< /note >}}
16+
17+
For further details, including permissions, see the
18+
[security checklist]({{< relref "/unit/howto/security.md#secutiry-apps" >}}).
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Install {{ app }}'s [app-link]. Here, we install it at **/path/to/app/**; use
2+
a real path in your configuration.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Install and configure {{ app }}'s [app-preq].
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Install [Unit]({{< relref "/unit/installation.md#installation-precomp-pkgs" >}}) with a {{ mod }} language module.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
.. include:: ../include/replace.rst
2+
```
3+
4+
Create a virtual environment to install {{ app }}'s [app-pip-link]:
5+
6+
```console
7+
$ cd :nxt_ph:`/path/to/app/ <Path to the application directory; use a real path in your configuration>`
8+
$ :nxt_hint:`python3 --version <Make sure your virtual environment version matches the module version>`
9+
Python :nxt_hint:`3.Y.Z <Major version, minor version, and revision number>`
10+
$ python3 -m venv :nxt_hint:`venv <Arbitrary name of the virtual environment>`
11+
$ source :nxt_hint:`venv <Name of the virtual environment from the previous command>`/bin/activate
12+
$ pip install |app-pip-package|
13+
$ deactivate
14+
```
15+
16+
{{< warning >}}
17+
Create your virtual environment with a Python version that matches the
18+
language module from Step 1 up to the minor number (**3.Y** in this
19+
example). Also, the app **type** in Step 5 must {ref}`resolve
20+
<configuration-apps-common>` to a similarly matching version; Unit doesn't
21+
infer it from the environment.
22+
{{< /warning >}}
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Assuming the JSON above was added to
2+
`config.json`. Run the following command as root:
3+
4+
```console
5+
# curl -X PUT --data-binary @config.json --unix-socket \
6+
/path/to/control.unit.sock \ # Path to Unit's control socket in your installation
7+
http://localhost/config/ # Path to the config section in Unit's control API
8+
```
9+
10+
{{< note >}}
11+
The [control socket]({{< relref "/unit/installation.md#configuration-socket" >}}) path may vary; run
12+
`unitd -h` or see
13+
[Startup and shutdown]({{< relref "/unit/howto/source.md#source-startup" >}}) for details.
14+
{{< /note >}}

content/includes/unit/version.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
1.34.1

content/unit/_index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: NGINX Unit
3+
description: A lightweight web app server that combines several layers of the typical application stack into a single component.
4+
url: /nginx-unit/
5+
---
6+

content/unit/about.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: About NGINX Unit
3+
weight: 100
4+
toc: true
5+
---
6+
7+
# Universal web app server
8+
9+
NGINX Unit is a lightweight and versatile application runtime that provides the
10+
essential components for your web application as a single open-source server:
11+
running application code (including WebAssembly), serving static assets,
12+
handling TLS and request routing.
13+
14+
Unit was created by [nginx](https://nginx.org/en/) team members from scratch to
15+
be highly efficient and fully configurable at runtime. You can read the details
16+
about the latest release in the [news]({{< relref "/unit/news/">}}) section.
17+
18+
- See a quickstart [guide](https://github.com/nginx/unit/) on our GitHub page.
19+
- Browse the [Changelog]({{< relref "/unit/changes/">}}) or see the release notes in the [Releases and announcements]({{< relref "/unit/news/">}}) archive.
20+
- Check out the discussion of our [key features]({{< relref "/unit/keyfeatures.md">}}) for further
21+
details.
22+
- Peek at our future plans with a GitHub-based [roadmap](https://github.com/orgs/nginx/projects/1).
23+
24+
25+
Watch the entire NGINX Unit tutorial course in the [NGINX YouTube channel](https://www.youtube.com/playlist?list=PLGz_X9w9raXdV3vuPUu0kKBSBjG9rPaUf).

0 commit comments

Comments
 (0)