Skip to content

Commit 397a126

Browse files
committed
Update documentation
1 parent 7c6bfce commit 397a126

File tree

2 files changed

+48
-31
lines changed

2 files changed

+48
-31
lines changed

docs/docs/index.md

Lines changed: 42 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**WARNING:** *Before starting go through the links on the [reference page](https://github.com/WordOps/nginx-build/wiki/References).*
66

7-
**NOTE:** *This guide is for building the version 1.16.1 of Nginx. You might need to change the commands according to the latest stable version of Nginx.*
7+
**NOTE:** *This guide is for building the version 1.22.1 of Nginx. You might need to change the commands according to the latest stable version of Nginx.*
88

99
1. Start the container.
1010

@@ -21,6 +21,7 @@ docker run --name=nginx-build -dit -v $PWD:/root/data virtubox/nginx-build bash
2121
```bash
2222
docker exec -it nginx-build bash
2323
```
24+
2425
4. Import the your GPG keys.
2526

2627
```bash
@@ -48,34 +49,27 @@ export DEBFULLNAME="WordOps"
4849
bash ppa.sh [email protected]
4950
```
5051

51-
8. To update the changelog and increment the package version, use the command :
52-
53-
```bash
54-
cd ~/PPA/nginx/nginx-1.16.1
55-
debchange -i -D xenial
56-
```
57-
58-
It will open your favorite editor to add content into the changelog
52+
At the end, the script will open your favorite editor to add content into the changelog.
5953

6054
```bash
61-
nginx (1.16.1-1ppa~stable~ubuntu16.04.2) xenial; urgency=medium
55+
nginx (1.22.1-1ppa~stable) jammy; urgency=medium
6256

63-
* Update to Nginx 1.16.1 in response to HTTP/2 vulnerabilities
57+
* Update to Nginx 1.22.1 in response to HTTP/2 vulnerabilities
6458

65-
-- Thomas SUCHON <[email protected]> Fri, 23 Aug 2019 01:03:00 +0530
59+
-- Thomas SUCHON <[email protected]> Fri, 19 Oct 2022 01:03:00 +0530
6660
```
6761

6862
This revision number of the build in bold has to be changed to build it
69-
successfully. (1.16.1-1ppa~stable~ubuntu16.04.2) This will download the latest Nginx source, the modules from their respective
63+
successfully. (1.22.1-1ppa~stable) This will download the latest Nginx source, the modules from their respective
7064
Github links, modify the changelog and create the whole directory structure at `~/PPA/nginx`
7165

72-
9. Go to the nginx directory (check the latest version)
66+
8. Go to the nginx directory (check the latest version)
7367

7468
```bash
75-
cd ~/PPA/nginx/nginx-1.16.1
69+
cd ~/PPA/nginx/nginx-1.22.1
7670
```
7771

78-
10. Start the packaging with the GPG keys that you have exported. If in doubt about GPGKEY, you can check [this page.](https://github.com/WordOps/nginx-build/wiki/Generating-GPG-Keys)
72+
9. Start the packaging with the GPG keys that you have exported. If in doubt about GPGKEY, you can check [this page.](https://github.com/WordOps/nginx-build/wiki/Generating-GPG-Keys)
7973

8074
```bash
8175
debuild -S -sd -k97BAD476
@@ -87,44 +81,68 @@ This is the key ID for WordOps GPG key. You will be asked for a password. Get th
8781

8882
#### Opensuse Build Service
8983

90-
11. Checkout the repository. If you don't have a repository, go to [Opensuse Build Service](https://build.opensuse.org), and create one
84+
10. Checkout the repository. If you don't have a repository, go to [Opensuse Build Service](https://build.opensuse.org), and create one
9185

9286
```bash
9387
cd ~
9488
osc co home:virtubox:WordOps
9589
```
90+
9691
**Warning**: The repository name is case sensitive.
9792

98-
12. Remove the current files from the nginx repo.
93+
11. Remove the current files from the nginx repo.
9994

10095
```bash
10196
cd home\:virtubox\:WordOps/nginx
10297
osc rm *
10398
```
10499

105-
13. The files that need to be uploaded will be generated in the `~/PPA/nginx`
100+
12. The files that need to be uploaded will be generated in the `~/PPA/nginx`
106101
directory. Only the files you already see [here](https://build.opensuse.org/package/show/home:virtubox:WordOps/nginx)
107102
will be necessary.
108103
Copy the files from `~/PPA/nginx` to `~/home:virtubox/nginx`.
109104

110105
```bash
111-
rsync -avzP --exclude="modules" --exclude="nginx-1.16.1" ~/PPA/nginx/ ~/home:virtubox:WordOps/nginx/
106+
rsync -avzP --exclude="modules" --exclude="nginx-1.22.1" ~/PPA/nginx/ ~/home:virtubox:WordOps/nginx/
112107
```
113108

114-
14. Add the new files to the repo.
109+
13. Add the new files to the repo.
115110

116111
```bash
117112
osc add *
118113
```
119114

120-
15. Commit and push the changes.
115+
14. Commit and push the changes.
121116

122117
```bash
123-
osc ci -m Revision message describing any changes
118+
osc ci -m "Revision message describing any changes"
124119
```
125120

126121
#### LaunchPad PPA
127122

123+
For LauchPad PPA, nginx package name have to include the Ubuntu release you want to build. For this we will use the tool backportpackage to create each version of nginx package we want.
124+
125+
1. Go into the nginx directory
126+
127+
```bash
128+
cd ~/PPA/nginx
129+
```
130+
131+
2. Then use `backportpackage` on the .dsc file previously built for OpenSuse repository
132+
133+
```bash
134+
backportpackage -r -w . -d bionic -d jammy -d focal -k97BAD476 nginx_1.22.1-1ppa~stable.dsc
135+
```
128136

137+
Replace `-k97BAD476` with your GPG key ID.
138+
It will build 3 nginx packages, for Ubuntu 18.04 (bionic), Ubuntu 20.04 (focal) and Ubuntu 22.04 (jammy).
139+
140+
3. Upload your package to LaunchPad PPA
141+
142+
```bash
143+
dput ppa:virtubox/nginx nginx_1.22.1-1ppa~stable~ubuntu18.04.1_source.changes
144+
dput ppa:virtubox/nginx nginx_1.22.1-1ppa~stable~ubuntu20.04.1_source.changes
145+
dput ppa:virtubox/nginx nginx_1.22.1-1ppa~stable~ubuntu22.04.1_source.changes
146+
```
129147

130-
17. Pat yourself on the back for a job well done. :)
148+
You have to upload an indivual nginx package for each Ubuntu release you want to support.

docs/mkdocs.yml

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
site_name: Nginx debian package build Documentation
2-
copyright: 'Copyright &copy; 2019 WordOps - <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img style="display:inline;" alt="Licence Creative Commons" style="border-width:0" src="https://docs.wordops.net/images/80x15.png" /></a>'
2+
copyright: 'Copyright &copy; 2022 WordOps - <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img style="display:inline;" alt="Licence Creative Commons" style="border-width:0" src="https://docs.wordops.net/images/80x15.png" /></a>'
33
repo_url: https://github.com/WordOps/nginx-build/
44
edit_uri: "https://github.com/WordOps/nginx-build/edit/master/docs/"
55
remote_branch: gh-pages
@@ -37,16 +37,15 @@ markdown_extensions:
3737
# block div
3838
- admonition
3939
- meta
40+
- attr_list
4041

4142
extra:
4243
social:
43-
- type: globe
44+
- icon: fontawesome/solid/globe
4445
link: https://wordops.net
45-
- type: github-alt
46+
- icon: fontawesome/brands/github-alt
4647
link: https://github.com/WordOps
47-
- type: twitter
48+
- icon: fontawesome/brands/twitter
4849
link: https://twitter.com/WordOps_
49-
- type: slack
50-
link: https://community.wordops.io/slack
51-
- type: comments
50+
- icon: fontawesome/solid/comment
5251
link: https://community.wordops.net

0 commit comments

Comments
 (0)