Skip to content

Commit 568911a

Browse files
joseluisqjoseluisq
committed
refactor: v3 beta updates for docker-related docs
1 parent cd07e47 commit 568911a

3 files changed

Lines changed: 34 additions & 32 deletions

File tree

‎src/v3/features/docker.md‎

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -63,25 +63,25 @@ To run SWS, there are several Docker image variants that you can use.
6363
### Scratch (just the binary)
6464

6565
```sh
66-
docker run --rm -it -p 8787:80 joseluisq/static-web-server:2 -g info
66+
docker run --rm -it -p 8787:8787 joseluisq/static-web-server:3.0.0-beta.1 -g info
6767
# or
68-
docker run --rm -it -p 8787:80 ghcr.io/static-web-server/static-web-server:2 -g info
68+
docker run --rm -it -p 8787:8787 ghcr.io/static-web-server/static-web-server:3.0.0-beta.1 -g info
6969
```
7070

7171
### Alpine
7272

7373
```sh
74-
docker run --rm -it -p 8787:80 joseluisq/static-web-server:2-alpine -g info
74+
docker run --rm -it -p 8787:8787 joseluisq/static-web-server:3.0.0-beta.1-alpine -g info
7575
# or
76-
docker run --rm -it -p 8787:80 ghcr.io/static-web-server/static-web-server:2-alpine -g info
76+
docker run --rm -it -p 8787:8787 ghcr.io/static-web-server/static-web-server:3.0.0-beta.1-alpine -g info
7777
```
7878

7979
### Debian
8080

8181
```sh
82-
docker run --rm -it -p 8787:80 joseluisq/static-web-server:2-debian -g info
82+
docker run --rm -it -p 8787:8787 joseluisq/static-web-server:3.0.0-beta.1-debian -g info
8383
# or
84-
docker run --rm -it -p 8787:80 ghcr.io/static-web-server/static-web-server:2-debian -g info
84+
docker run --rm -it -p 8787:8787 ghcr.io/static-web-server/static-web-server:3.0.0-beta.1-debian -g info
8585
```
8686

8787
## FIPS-validated TLS
@@ -96,7 +96,7 @@ Platforms supported by FIPS images are `linux/amd64` and `linux/arm64` only.
9696
To verify that the image supports FIPS mode, check the output of the following command:
9797

9898
```sh{3}
99-
docker run --rm ghcr.io/static-web-server/static-web-server:2-fips -V | grep -i "fips"
99+
docker run --rm ghcr.io/static-web-server/static-web-server:3.0.0-beta.1-fips -V | grep -i "fips"
100100
# FIPS Mode:
101101
# Module Version: AWS-LC-FIPS 3.0.x
102102
# Crypto Provider: aws-lc-rs (via aws-lc-fips-sys)
@@ -106,25 +106,25 @@ docker run --rm ghcr.io/static-web-server/static-web-server:2-fips -V | grep -i
106106

107107
```sh
108108
# Scratch (just the binary)
109-
docker run --rm -it -p 8787:80 joseluisq/static-web-server:2-fips -g info
109+
docker run --rm -it -p 8787:8787 joseluisq/static-web-server:3.0.0-beta.1-fips -g info
110110
# or
111-
docker run --rm -it -p 8787:80 ghcr.io/static-web-server/static-web-server:2-fips -g info
111+
docker run --rm -it -p 8787:8787 ghcr.io/static-web-server/static-web-server:3.0.0-beta.1-fips -g info
112112
```
113113

114114
### Alpine {#fips-alpine}
115115

116116
```sh
117-
docker run --rm -it -p 8787:80 joseluisq/static-web-server:2-fips-alpine -g info
117+
docker run --rm -it -p 8787:8787 joseluisq/static-web-server:3.0.0-beta.1-fips-alpine -g info
118118
# or
119-
docker run --rm -it -p 8787:80 ghcr.io/static-web-server/static-web-server:2-fips-alpine -g info
119+
docker run --rm -it -p 8787:8787 ghcr.io/static-web-server/static-web-server:3.0.0-beta.1-fips-alpine -g info
120120
```
121121

122122
### Debian {#fips-debian}
123123

124124
```sh
125-
docker run --rm -it -p 8787:80 joseluisq/static-web-server:2-fips-debian -g info
125+
docker run --rm -it -p 8787:8787 joseluisq/static-web-server:3.0.0-beta.1-fips-debian -g info
126126
# or
127-
docker run --rm -it -p 8787:80 ghcr.io/static-web-server/static-web-server:2-fips-debian -g info
127+
docker run --rm -it -p 8787:8787 ghcr.io/static-web-server/static-web-server:3.0.0-beta.1-fips-debian -g info
128128
```
129129

130130
### Development
@@ -133,9 +133,9 @@ Additionally, we publish **development** Docker images based on `master` branch
133133

134134
```sh
135135
# Scratch (just the binary)
136-
docker run --rm -it -p 8787:80 ghcr.io/static-web-server/static-web-server:devel -g info
136+
docker run --rm -it -p 8787:8787 ghcr.io/static-web-server/static-web-server:devel -g info
137137
# Debian
138-
docker run --rm -it -p 8787:80 ghcr.io/static-web-server/static-web-server:devel-debian -g info
138+
docker run --rm -it -p 8787:8787 ghcr.io/static-web-server/static-web-server:devel-debian -g info
139139
```
140140

141141
## Dockerfile
@@ -145,27 +145,27 @@ SWS Docker images can be extended as needed.
145145
Extending the **Scratch** Docker image (just the binary)
146146

147147
```Dockerfile
148-
FROM joseluisq/static-web-server:2
148+
FROM joseluisq/static-web-server:3.0.0-beta.1
149149
# or
150-
FROM ghcr.io/static-web-server/static-web-server:2
150+
FROM ghcr.io/static-web-server/static-web-server:3.0.0-beta.1
151151
# do stuff...
152152
```
153153

154154
Or the **Alpine**
155155

156156
```Dockerfile
157-
FROM joseluisq/static-web-server:2-alpine
157+
FROM joseluisq/static-web-server:3.0.0-beta.1-alpine
158158
# or
159-
FROM ghcr.io/static-web-server/static-web-server:2-alpine
159+
FROM ghcr.io/static-web-server/static-web-server:3.0.0-beta.1-alpine
160160
# do stuff...
161161
```
162162

163163
Or the **Debian**
164164

165165
```Dockerfile
166-
FROM joseluisq/static-web-server:2-debian
166+
FROM joseluisq/static-web-server:3.0.0-beta.1-debian
167167
# or
168-
FROM ghcr.io/static-web-server/static-web-server:2-debian
168+
FROM ghcr.io/static-web-server/static-web-server:3.0.0-beta.1-debian
169169
# do stuff...
170170
```
171171

@@ -178,10 +178,10 @@ version: '3.3'
178178

179179
services:
180180
website:
181-
image: joseluisq/static-web-server:2-alpine
181+
image: joseluisq/static-web-server:3.0.0-beta.1-alpine
182182
container_name: 'website'
183183
ports:
184-
- 80:80
184+
- 8787:8787
185185
restart: unless-stopped
186186
environment:
187187
# Note: those envs are customizable but also optional
@@ -220,21 +220,23 @@ services:
220220
- '/var/run/docker.sock:/var/run/docker.sock:ro'
221221
222222
website:
223-
image: joseluisq/static-web-server:2
223+
image: joseluisq/static-web-server:3.0.0-beta.1
224224
environment:
225225
# Note: those envs are customizable but also optional
226226
- SERVER_ROOT=/public
227227
volumes:
228228
- /var/www/website:/public
229229
# Or use an existing Docker volume
230230
# - website_data:/public
231+
ports:
232+
- '8787:8787'
231233
labels:
232234
- 'traefik.enable=true'
233235
- 'traefik.docker.network=traefik_net'
234236
- 'traefik.http.routers.website.entrypoints=web'
235237
- 'traefik.http.routers.website.rule=Host(`website.localhost`)'
236238
- 'traefik.http.routers.website.priority=1'
237-
- 'traefik.http.services.website.loadbalancer.server.port=80'
239+
- 'traefik.http.services.website.loadbalancer.server.port=8787'
238240
networks:
239241
- traefik_net
240242

@@ -259,13 +261,13 @@ metadata:
259261
spec:
260262
containers:
261263
- name: sws
262-
image: ghcr.io/static-web-server/static-web-server
264+
image: ghcr.io/static-web-server/static-web-server:3.0.0-beta.1
263265
command:
264266
- static-web-server
265267
- --root=/public
266268
- --health
267269
ports:
268-
- containerPort: 80
270+
- containerPort: 8787
269271
livenessProbe:
270272
httpGet:
271273
path: /health

‎src/v3/features/http-https-redirect.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ static-web-server -p 4433 -d public/ -g trace \
4949
# HTTPS redirect options
5050
--https-redirect=true \
5151
--https-redirect-host="localhost" \
52-
--https-redirect-from-port=80 \
52+
--https-redirect-from-port=8787 \
5353
--https-redirect-from-hosts="localhost"
5454
# or using multiple hostnames/IPs:
5555
# --https-redirect-from-hosts = "localhost,127.0.0.1"
@@ -61,11 +61,11 @@ After running the server, the logs should look as follows.
6161
.......
6262
2023-06-01T22:30:17.555338Z INFO static_web_server::server: http to https redirect: enabled=true
6363
2023-06-01T22:30:17.555349Z INFO static_web_server::server: http to https redirect host: localhost
64-
2023-06-01T22:30:17.555359Z INFO static_web_server::server: http to https redirect from port: 80
64+
2023-06-01T22:30:17.555359Z INFO static_web_server::server: http to https redirect from port: 8787
6565
2023-06-01T22:30:17.555368Z INFO static_web_server::server: http to https redirect from hosts: localhost
6666
2023-06-01T22:30:17.557507Z INFO Server::start_server{addr_str="[::]:4433" threads=8}: static_web_server::server: close time.busy=0.00ns time.idle=3.00µs
6767
2023-06-01T22:30:17.557547Z INFO static_web_server::server: http2 server is listening on https://[::]:4433
68-
2023-06-01T22:30:17.557583Z INFO Server::start_server{addr=[::]:80 threads=8}: static_web_server::server: close time.busy=0.00ns time.idle=1.92µs
69-
2023-06-01T22:30:17.557596Z INFO static_web_server::server: http1 redirect server is listening on http://[::]:80
68+
2023-06-01T22:30:17.557583Z INFO Server::start_server{addr=[::]:8787 threads=8}: static_web_server::server: close time.busy=0.00ns time.idle=1.92µs
69+
2023-06-01T22:30:17.557596Z INFO static_web_server::server: http1 redirect server is listening on http://[::]:8787
7070
2023-06-01T22:30:17.557768Z INFO static_web_server::server: press ctrl+c to shut down the servers
7171
```

‎src/v3/quick-start.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ static-web-server --port 8787 --root ./my-public-dir
99
Or if you use [Docker](https://www.docker.com/) just try
1010

1111
```sh
12-
docker run --rm -it -p 8787:80 joseluisq/static-web-server:2
12+
docker run --rm -it -p 8787:8787 joseluisq/static-web-server:3.0.0-beta.1 -g info
1313
```
1414

1515
> [!INFO] Docker Tip

0 commit comments

Comments
 (0)