Skip to content

Commit

Permalink
Docs, bump ver
Browse files Browse the repository at this point in the history
  • Loading branch information
MotorTruck1221 committed Dec 21, 2024
1 parent 6bbf40a commit e2795ff
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 10 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,7 @@

# 1.1.3
- Add the notice that ScramJet is in beta and may break

# 1.1.4
- Add the ability to disable/enable SEO or selectively render/show it
- Adds the docker-builds.yml file to show the builds I am doing for the docker images.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,12 +244,19 @@ docker compose -f ./docker-compose.build.yml build
> As it says, `buildOpts` will only apply when *building* the website. This can be changed in the docker-compose files.
##### Build Opts
| Type | Default | Description |
|------|---------|------------------------------------|
| games | `true` | Disables or enables the games page |
| Type | Default | Description | Can be overwritten by ENV var |
|------|---------|------------------------------------|-------------------------------|
| games | `true` | Disables or enables the games page | - [ ] - No |

##### Server
| Type | Default | Description |
|------|---------|-----------------------------------------------------------------------------------------------------------------|
| port | `8000` | Change the default port. *Note: the environment var `PORT` takes precedence* |
| wisp | `true` | Disable or enables the in built wisp server. *Note: when using the Hono server there is no built-in wisp server |
| Type | Default | Description | Can be overwritten by ENV var |
|------|---------|-----------------------------------------------------------------------------------------------------------------|------------------------------|
| port | `8000` | Change the default port. *Note: the environment var `PORT` takes precedence* | - [x] - Yes |
| wisp | `true` | Disable or enables the in built wisp server. *Note: when using the Hono server there is no built-in wisp server | - [ ] - No |

##### SEO
| Type | Default | Description | Can be overwritten by ENV var | Is used at build time |
---------|-------------------------|--------------------------------------------------------------------------|-------------------------------|-----------------------|
| SEO | `false` | Change whether or not to enabled SEO | - [x] - Yes - `SEO` | - [x] - Yes |
| DOMAIN | `http://localhost:8000` | When the `both` option is enable, only show the SEO stuff on this domain | - [x] - Yes - `DOMAIN` | - [ ] - No |
| BOTH | `false` | Works in tandem with option `DOMAIN` | - [x] - Yes - `BOTH` | - [ ] - No |
4 changes: 2 additions & 2 deletions docker-builds.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ services:
container_name: incognito
restart: unless-stopped
incognito-versioned:
image: motortruck1221/incognito:1.1.3
image: motortruck1221/incognito:1.1.4
build:
context: .
dockerfile: Dockerfile
Expand All @@ -30,7 +30,7 @@ services:
- SEO=true
- BOTH=true
incognito-seo-versioned:
image: motortruck1221/incognito:1.1.3-seo
image: motortruck1221/incognito:1.1.4-seo
build:
context: .
dockerfile: Dockerfile
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "incognito",
"version": "1.1.3",
"version": "1.1.4",
"private": true,
"type": "module",
"dependencies": {
Expand Down

0 comments on commit e2795ff

Please sign in to comment.