Compare commits
30 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 22735a9ea6 | |||
| 9367999ef2 | |||
| d42824d41a | |||
| 7d2186860c | |||
| 99dfaddf04 | |||
| 45b9ac1281 | |||
| 8d0d804923 | |||
| fe91ce6ed3 | |||
| a6c627a178 | |||
| 763ddd8bd7 | |||
| 3016a6da70 | |||
| f0b2433b59 | |||
| b92c75b131 | |||
| 4ca4fd9559 | |||
| 3deacd7e80 | |||
| a0f44eacce | |||
| 87eeb7f553 | |||
| 2d06d34c7c | |||
| 3f8f8fa773 | |||
| 5f72eae55c | |||
| 96e580e56a | |||
| ca12844268 | |||
| 76fa0649f2 | |||
| 3b4ac12582 | |||
| eb55709be5 | |||
| 446b49c9a0 | |||
| 36c309a69c | |||
| 3f55ad71cf | |||
| f8ec31ff7e | |||
| 739311928f |
@@ -1,6 +1,10 @@
|
|||||||
WEB_PORT=3100
|
WEB_PORT=3100
|
||||||
|
|
||||||
DB_HOSTNAME=database
|
WEB_ORIGIN=http://localhost:3001
|
||||||
|
|
||||||
|
DB_HOSTNAME=localhost
|
||||||
|
DB_PORTNAME=3306
|
||||||
|
|
||||||
DB_DATABASE=news
|
DB_DATABASE=news
|
||||||
DB_USERNAME=news
|
DB_USERNAME=news
|
||||||
DB_PASSWORD=venusaur
|
DB_PASSWORD=venusaur
|
||||||
@@ -15,4 +19,4 @@ DB_LOGGING=
|
|||||||
SECRET_ACCESS=access
|
SECRET_ACCESS=access
|
||||||
|
|
||||||
# Select the default number of articles returned by a GET request
|
# Select the default number of articles returned by a GET request
|
||||||
QUERY_LIMIT=10
|
PAGE_SIZE=10
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
# These are supported funding model platforms
|
||||||
|
|
||||||
|
patreon: krgamestudios
|
||||||
|
ko_fi: krgamestudios
|
||||||
|
custom: ["https://www.paypal.com/donate/?hosted_button_id=73Q82T2ZHV8AA"]
|
||||||
+2
-2
@@ -1,7 +1,7 @@
|
|||||||
|
|
||||||
FROM node:16
|
FROM node:22-bookworm-slim
|
||||||
WORKDIR "/app"
|
WORKDIR "/app"
|
||||||
COPY package*.json ./
|
COPY package*.json /app
|
||||||
RUN npm install --production
|
RUN npm install --production
|
||||||
COPY . /app
|
COPY . /app
|
||||||
EXPOSE 3100
|
EXPOSE 3100
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
Copyright (c) 2021 Kayne Ruse, KR Game Studios
|
Copyright (c) 2021-2023 Kayne Ruse, KR Game Studios
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.
|
This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.
|
||||||
|
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ This server is available via docker hub at krgamestudios/news-server.
|
|||||||
|
|
||||||
# Setup
|
# Setup
|
||||||
|
|
||||||
There are multiple ways to run this app - it can run on it's own via `npm start` (for production) or `npm run dev` (for development). it can also run inside docker using `docker-compose up --build` - run `node configure-script.js` to generate docker-compose.yml and startup.sql.
|
There are multiple ways to run this app - it can run on it's own via `npm start` (for production) or `npm run dev` (for development). it can also run inside docker using `docker compose up --build` - run `node configure-script.js` to generate docker-compose.yml and startup.sql.
|
||||||
|
|
||||||
To generate an authorization token, use [auth-server](https://github.com/krgamestudios/auth-server). A public-facing development auth-server is available here (tokens are valid for 10 minutes):
|
To generate an authorization token, use [auth-server](https://github.com/krgamestudios/auth-server). A public-facing development auth-server is available here (tokens are valid for 10 minutes):
|
||||||
|
|
||||||
@@ -15,119 +15,255 @@ POST https://dev-auth.krgamestudios.com/auth/login HTTP/1.1
|
|||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
|
|
||||||
{
|
{
|
||||||
"email": "kayneruse@gmail.com",
|
"email": "example@example.com",
|
||||||
"password": "helloworld"
|
"password": "helloworld"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
# API
|
# API
|
||||||
|
|
||||||
|
### `GET /news/:id?`
|
||||||
|
|
||||||
|
Get either an array of articles (newest first), or a specified article if the optional "id" parameter is given.
|
||||||
|
|
||||||
|
#### Response Body
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
[{
|
||||||
|
// [Number] index of the article
|
||||||
|
"index": index,
|
||||||
|
|
||||||
|
// [String] author of the article
|
||||||
|
"author": author,
|
||||||
|
|
||||||
|
// [String] raw body of the article
|
||||||
|
"body": body,
|
||||||
|
|
||||||
|
// [Number] number of times this article has been edited
|
||||||
|
"edits": edits,
|
||||||
|
|
||||||
|
// [String] body of the article rendered as HTML
|
||||||
|
"rendered": rendered,
|
||||||
|
|
||||||
|
// [String] title of the article
|
||||||
|
"title": title,
|
||||||
|
|
||||||
|
// [Date] time article was created
|
||||||
|
"createdAt": createdAt,
|
||||||
|
|
||||||
|
// [Date] time article was updated
|
||||||
|
"updatedAt": updatedAt,
|
||||||
|
}]
|
||||||
```
|
```
|
||||||
//NOTE: GET will return an empty array if a specific article can't be found
|
|
||||||
//NOTE: you can add a "limit" query parameter to change the default limit
|
|
||||||
GET /news?limit=10
|
|
||||||
|
|
||||||
|
#### Available Query Parameters
|
||||||
|
|
||||||
###
|
- `fields`
|
||||||
|
- TYPE: `string`
|
||||||
|
A comma separated list of the field names you want returning, (index will always be returned)
|
||||||
|
- `page`
|
||||||
|
- TYPE: `number`
|
||||||
|
The current page you want returning
|
||||||
|
- `page_size`
|
||||||
|
- TYPE: `number`
|
||||||
|
The number of results to return. This superseeds the `PAGE_SIZE` environment variable for the query
|
||||||
|
|
||||||
|
> **NOTE**
|
||||||
|
> If a specific article is requested, then just that article is returned rather than an array
|
||||||
|
|
||||||
//DOCS: get latest news, up to a default limit, or specify the index "id"
|
### `GET /news/archive/:id?`
|
||||||
GET /news/:id
|
|
||||||
|
|
||||||
|
Get either an array of articles (oldest first), or a specified article if the optional "id" parameter is given.
|
||||||
|
|
||||||
###
|
#### Response Body
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
[{
|
||||||
|
// [Number] index of the article
|
||||||
|
"index": index,
|
||||||
|
|
||||||
//DOCS: get the news starting from the beginning, up to a default limit, or specify the index "id"
|
// [String] author of the article
|
||||||
GET /news/archive/:id
|
"author": author,
|
||||||
|
|
||||||
//DOCS: result (if only a single article is specified, returns just that article rather than an array):
|
// [String] raw body of the article
|
||||||
[
|
"body": body,
|
||||||
{
|
|
||||||
"index": index, //absolute index of the result
|
|
||||||
"title": title, //title of the article
|
|
||||||
"author": author, //author of the aricle
|
|
||||||
"body": body, //body of the article
|
|
||||||
"rendered": rendered //body rendered as HTML
|
|
||||||
"edits": edits //number of times this article has been edited
|
|
||||||
"createdAt": createdAt //time created
|
|
||||||
"updatedAt": updatedAt //time updated
|
|
||||||
},
|
|
||||||
...
|
|
||||||
]
|
|
||||||
|
|
||||||
|
// [Number] number of times this article has been edited
|
||||||
|
"edits": edits,
|
||||||
|
|
||||||
###
|
// [String] body of the article rendered as HTML
|
||||||
|
"rendered": rendered,
|
||||||
|
|
||||||
|
// [String] title of the article
|
||||||
|
"title": title,
|
||||||
|
|
||||||
//DOCS: get the latest metadata, up to a default limit, or specify the index "id"
|
// [Date] time article was created
|
||||||
GET /news/metadata/:id
|
"createdAt": createdAt,
|
||||||
|
|
||||||
|
// [Date] time article was updated
|
||||||
###
|
"updatedAt": updatedAt,
|
||||||
|
}]
|
||||||
|
|
||||||
//DOCS: get the metadata starting from the beginning, up to a default limit, or specify the index "id"
|
|
||||||
GET /news/archive/metadata/:id
|
|
||||||
|
|
||||||
//DOCS: result (if only a single article is specified, returns just that article rather than an array):
|
|
||||||
[
|
|
||||||
{
|
|
||||||
"index": index, //absolute index of the result
|
|
||||||
"title": title, //title of the article
|
|
||||||
"author": author //author of the article
|
|
||||||
"edits": edits //number of times this article has been edited
|
|
||||||
"createdAt": createdAt //time created
|
|
||||||
"updatedAt": updatedAt //time updated
|
|
||||||
},
|
|
||||||
...
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
|
|
||||||
//DOCS: send a formatted JSON object, returns new index on success, or error on failure
|
|
||||||
POST /news
|
|
||||||
Authorization: Bearer XXX
|
|
||||||
|
|
||||||
{
|
|
||||||
"title": title //title of the article
|
|
||||||
"author": author //author of the article
|
|
||||||
"body": body //body of the article
|
|
||||||
}
|
|
||||||
|
|
||||||
//DOCS: result (status 200 on success, otherwise an error status):
|
|
||||||
{
|
|
||||||
"index": index //new index of the article
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
|
|
||||||
//DOCS: similar to `POST /news`, but allows overwriting an existing article
|
|
||||||
PATCH /news/:id
|
|
||||||
Authorization: Bearer XXX
|
|
||||||
|
|
||||||
{
|
|
||||||
"title": title //title of the article, optional
|
|
||||||
"author": author //author of the article, optional
|
|
||||||
"body": body //body of the article, optional
|
|
||||||
}
|
|
||||||
|
|
||||||
//DOCS: result: status 200 on success, otherwise an error status
|
|
||||||
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
|
|
||||||
//DOCS: remove an article from the news feed
|
|
||||||
DELETE /news/:id
|
|
||||||
Authorization: Bearer XXX
|
|
||||||
|
|
||||||
//DOCS: result: status 200 on success, otherwise an error status
|
|
||||||
|
|
||||||
|
|
||||||
###
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Available Query Parameters
|
||||||
|
|
||||||
|
- `fields`
|
||||||
|
- TYPE: `string`
|
||||||
|
A comma separated list of the field names you want returning, (index will always be returned)
|
||||||
|
- `page`
|
||||||
|
- TYPE: `number`
|
||||||
|
The current page you want returning
|
||||||
|
- `page_size`
|
||||||
|
- TYPE: `number`
|
||||||
|
The number of results to return. This superseeds the `PAGE_SIZE` environment variable for the query
|
||||||
|
|
||||||
|
> **NOTE**
|
||||||
|
> If a specific article is requested, then just that article is returned rather than an array
|
||||||
|
|
||||||
|
### `GET /news/metadata/:id?`
|
||||||
|
|
||||||
|
Get either an array of metadata (newest first), or a specified article's metadata if the optional "id" parameter is given.
|
||||||
|
|
||||||
|
#### Response Body
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
[{
|
||||||
|
// [Number] index of the article
|
||||||
|
"index": index,
|
||||||
|
|
||||||
|
// [String] author of the article
|
||||||
|
"author": author,
|
||||||
|
|
||||||
|
// [Number] number of times this article has been edited
|
||||||
|
"edits": edits,
|
||||||
|
|
||||||
|
// [String] title of the article
|
||||||
|
"title": title,
|
||||||
|
|
||||||
|
// [Date] time article was created
|
||||||
|
"createdAt": createdAt,
|
||||||
|
|
||||||
|
// [Date] time article was updated
|
||||||
|
"updatedAt": updatedAt,
|
||||||
|
}]
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Available Query Parameters
|
||||||
|
|
||||||
|
- `fields`
|
||||||
|
- TYPE: `string`
|
||||||
|
A comma separated list of the field names you want returning, (index will always be returned)
|
||||||
|
- `page`
|
||||||
|
- TYPE: `number`
|
||||||
|
The current page you want returning
|
||||||
|
- `page_size`
|
||||||
|
- TYPE: `number`
|
||||||
|
The number of results to return. This superseeds the `PAGE_SIZE` environment variable for the query
|
||||||
|
|
||||||
|
> **NOTE**
|
||||||
|
> If a specific article is requested, then just that article is returned rather than an array
|
||||||
|
|
||||||
|
### `GET /news/archive/metadata/:id?`
|
||||||
|
|
||||||
|
Get either an array of metadata (oldest first), or a specified article's metadata if the optional "id" parameter is given.
|
||||||
|
|
||||||
|
#### Response Body
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
[{
|
||||||
|
// [Number] index of the article
|
||||||
|
"index": index,
|
||||||
|
|
||||||
|
// [String] author of the article
|
||||||
|
"author": author,
|
||||||
|
|
||||||
|
// [Number] number of times this article has been edited
|
||||||
|
"edits": edits,
|
||||||
|
|
||||||
|
// [String] title of the article
|
||||||
|
"title": title,
|
||||||
|
|
||||||
|
// [Date] time article was created
|
||||||
|
"createdAt": createdAt,
|
||||||
|
|
||||||
|
// [Date] time article was updated
|
||||||
|
"updatedAt": updatedAt,
|
||||||
|
}]
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Available Query Parameters
|
||||||
|
|
||||||
|
- `fields`
|
||||||
|
- TYPE: `string`
|
||||||
|
A comma separated list of the field names you want returning, (index will always be returned)
|
||||||
|
- `page`
|
||||||
|
- TYPE: `number`
|
||||||
|
The current page you want returning
|
||||||
|
- `page_size`
|
||||||
|
- TYPE: `number`
|
||||||
|
The number of results to return. This supersedes the `PAGE_SIZE` environment variable for the query
|
||||||
|
|
||||||
|
> **NOTE**
|
||||||
|
> If a specific article is requested, then just that article is returned rather than an array
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### `POST /news`
|
||||||
|
|
||||||
|
> **IMPORTANT**
|
||||||
|
> Requires valid JWT Authorization header (Authorization: Bearer XXX)
|
||||||
|
|
||||||
|
Create a new article resource, returns either the new article's index on success, or an error on failure.
|
||||||
|
|
||||||
|
#### Request Body
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
// [String] OPTIONAL: title of the article
|
||||||
|
"title": title,
|
||||||
|
|
||||||
|
// [String] OPTIONAL: author of the article
|
||||||
|
"author": author,
|
||||||
|
|
||||||
|
// [String] OPTIONAL: body of the article
|
||||||
|
"body": body,
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Response Body
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
// [Number]: new index of the article
|
||||||
|
"index": index,
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### `PATCH /news/:id`
|
||||||
|
|
||||||
|
> **IMPORTANT**
|
||||||
|
> Requires valid JWT Authorization header (Authorization: Bearer XXX)
|
||||||
|
|
||||||
|
Update an existing article resource, returns either status code 200 on success, or an error status on failure.
|
||||||
|
|
||||||
|
#### Request Body
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
// [String] OPTIONAL: title of the article
|
||||||
|
"title": title,
|
||||||
|
|
||||||
|
// [String] OPTIONAL: author of the article
|
||||||
|
"author": author,
|
||||||
|
|
||||||
|
// [String] OPTIONAL: body of the article
|
||||||
|
"body": body,
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### `DELETE /news/:id`
|
||||||
|
|
||||||
|
> **IMPORTANT**
|
||||||
|
> Requires valid JWT Authorization header (Authorization: Bearer XXX)
|
||||||
|
|
||||||
|
Remove an existing article resource from the news feed, returns either status code 200 on success, or an error status on failure.
|
||||||
+56
-29
@@ -30,8 +30,28 @@ const question = (prompt, def = null) => {
|
|||||||
//project configuration
|
//project configuration
|
||||||
const appName = await question('App Name', 'news');
|
const appName = await question('App Name', 'news');
|
||||||
const appWebAddress = await question('Web Addr', `${appName}.example.com`);
|
const appWebAddress = await question('Web Addr', `${appName}.example.com`);
|
||||||
|
const appWebOrigin = await question('Web Origin', `https://example.com`); //TODO: clean these up properly
|
||||||
const appPort = await question('App Port', '3100');
|
const appPort = await question('App Port', '3100');
|
||||||
|
|
||||||
|
//configure the database address
|
||||||
|
let dbLocation = '';
|
||||||
|
while (typeof dbLocation != 'string' || /^[le]/i.test(dbLocation[0]) == false) {
|
||||||
|
dbLocation = await question('[l]ocal or [e]xternal database?');
|
||||||
|
}
|
||||||
|
|
||||||
|
let appDBHost = '';
|
||||||
|
let appDBPort = '';
|
||||||
|
|
||||||
|
if (/^[l]/i.test(dbLocation[0])) {
|
||||||
|
appDBHost = 'database';
|
||||||
|
appDBPort = '3306';
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
appDBHost = await question('DB Host');
|
||||||
|
appDBPort = await question('DB Port', '3306');
|
||||||
|
}
|
||||||
|
|
||||||
|
//configure the database account
|
||||||
const appDBUser = await question('DB User', appName);
|
const appDBUser = await question('DB User', appName);
|
||||||
const appDBPass = await question('DB Pass', 'venusaur');
|
const appDBPass = await question('DB Pass', 'venusaur');
|
||||||
const dbRootPass = await question('DB Root Pass');
|
const dbRootPass = await question('DB Root Pass');
|
||||||
@@ -42,38 +62,43 @@ const question = (prompt, def = null) => {
|
|||||||
|
|
||||||
//generate the files
|
//generate the files
|
||||||
const ymlfile = `
|
const ymlfile = `
|
||||||
version: '3'
|
|
||||||
|
|
||||||
services:
|
services:
|
||||||
${appName}:
|
${appName}:
|
||||||
build:
|
build:
|
||||||
context: .
|
context: .
|
||||||
ports:
|
ports:
|
||||||
- "${appPort}"
|
- ${appPort}
|
||||||
labels:
|
labels:
|
||||||
- "traefik.enable=true"
|
- traefik.enable=true
|
||||||
- "traefik.http.routers.${appName}router.rule=Host(\`${appWebAddress}\`)"
|
- traefik.http.routers.${appName}router.rule=Host(\`${appWebAddress}\`)
|
||||||
- "traefik.http.routers.${appName}router.entrypoints=websecure"
|
- traefik.http.routers.${appName}router.entrypoints=websecure
|
||||||
- "traefik.http.routers.${appName}router.tls.certresolver=myresolver"
|
- traefik.http.routers.${appName}router.tls.certresolver=myresolver
|
||||||
- "traefik.http.routers.${appName}router.service=${appName}service@docker"
|
- traefik.http.routers.${appName}router.service=${appName}service@docker
|
||||||
- "traefik.http.services.${appName}service.loadbalancer.server.port=${appPort}"
|
- traefik.http.services.${appName}service.loadbalancer.server.port=${appPort}
|
||||||
environment:
|
environment:
|
||||||
- WEB_PORT=${appPort}
|
- WEB_PORT=${appPort}
|
||||||
- DB_HOSTNAME=database
|
- WEB_ORIGIN=${appWebOrigin}
|
||||||
|
- DB_HOSTNAME=${appDBHost}
|
||||||
|
- DB_PORTNAME=${appDBPort}
|
||||||
- DB_DATABASE=${appName}
|
- DB_DATABASE=${appName}
|
||||||
- DB_USERNAME=${appDBUser}
|
- DB_USERNAME=${appDBUser}
|
||||||
- DB_PASSWORD=${appDBPass}
|
- DB_PASSWORD=${appDBPass}
|
||||||
- DB_TIMEZONE=Australia/Sydney
|
- DB_TIMEZONE=Australia/Sydney
|
||||||
- QUERY_LIMIT=10
|
- PAGE_SIZE=10
|
||||||
- SECRET_ACCESS=${appSecretAccess}
|
- SECRET_ACCESS=${appSecretAccess}
|
||||||
|
volumes:
|
||||||
|
- /etc/timezone:/etc/timezone:ro
|
||||||
|
- /etc/localtime:/etc/localtime:ro
|
||||||
networks:
|
networks:
|
||||||
- app-network
|
- app-network${ appDBHost != 'database' ? '' : `
|
||||||
depends_on:
|
depends_on:
|
||||||
- database
|
- database
|
||||||
|
|
||||||
database:
|
database:
|
||||||
image: mariadb:latest
|
image: mariadb:latest
|
||||||
environment:
|
environment:
|
||||||
MYSQL_DATABASE: ${appName}
|
MYSQL_DATABASE: ${appName}
|
||||||
|
MYSQL_TCP_PORT: ${appDBPort}
|
||||||
MYSQL_USER: ${appDBUser}
|
MYSQL_USER: ${appDBUser}
|
||||||
MYSQL_PASSWORD: ${appDBPass}
|
MYSQL_PASSWORD: ${appDBPass}
|
||||||
MYSQL_ROOT_PASSWORD: ${dbRootPass}
|
MYSQL_ROOT_PASSWORD: ${dbRootPass}
|
||||||
@@ -82,36 +107,38 @@ services:
|
|||||||
volumes:
|
volumes:
|
||||||
- ./mysql:/var/lib/mysql
|
- ./mysql:/var/lib/mysql
|
||||||
- ./startup.sql:/docker-entrypoint-initdb.d/startup.sql:ro
|
- ./startup.sql:/docker-entrypoint-initdb.d/startup.sql:ro
|
||||||
|
- /etc/timezone:/etc/timezone:ro
|
||||||
|
- /etc/localtime:/etc/localtime:ro`}
|
||||||
|
|
||||||
traefik_${appName}:
|
traefik_${appName}:
|
||||||
container_name: ${appName}_traefik
|
image: traefik:latest
|
||||||
image: "traefik:v2.4"
|
|
||||||
container_name: "traefik"
|
|
||||||
command:
|
command:
|
||||||
- "--log.level=ERROR"
|
- --log.level=ERROR
|
||||||
- "--api.insecure=false"
|
- --api.insecure=false
|
||||||
- "--providers.docker=true"
|
- --providers.docker=true
|
||||||
- "--providers.docker.exposedbydefault=false"
|
- --providers.docker.exposedbydefault=false
|
||||||
- "--entrypoints.websecure.address=:443"
|
- --entrypoints.websecure.address=:443
|
||||||
- "--certificatesresolvers.myresolver.acme.tlschallenge=true"
|
- --certificatesresolvers.myresolver.acme.tlschallenge=true
|
||||||
- "--certificatesresolvers.myresolver.acme.email=${supportEmail}"
|
- --certificatesresolvers.myresolver.acme.email=${supportEmail}
|
||||||
- "--certificatesresolvers.myresolver.acme.storage=/letsencrypt/acme.json"
|
- --certificatesresolvers.myresolver.acme.storage=/letsencrypt/acme.json
|
||||||
ports:
|
ports:
|
||||||
- "80:80"
|
- 80:80
|
||||||
- "443:443"
|
- 443:443
|
||||||
volumes:
|
volumes:
|
||||||
- "./letsencrypt:/letsencrypt"
|
- ./letsencrypt:/letsencrypt
|
||||||
- "/var/run/docker.sock:/var/run/docker.sock:ro"
|
- /var/run/docker.sock:/var/run/docker.sock:ro
|
||||||
networks:
|
networks:
|
||||||
- app-network
|
- app-network
|
||||||
|
|
||||||
networks:
|
networks:
|
||||||
app-network:
|
app-network:
|
||||||
driver: bridge
|
driver: bridge
|
||||||
`;
|
`;
|
||||||
|
|
||||||
const dockerfile = `
|
const dockerfile = `
|
||||||
FROM node:16
|
FROM node:22-bookworm-slim
|
||||||
WORKDIR "/app"
|
WORKDIR "/app"
|
||||||
COPY package*.json ./
|
COPY package*.json /app
|
||||||
RUN npm install --production
|
RUN npm install --production
|
||||||
COPY . /app
|
COPY . /app
|
||||||
EXPOSE ${appPort}
|
EXPOSE ${appPort}
|
||||||
|
|||||||
Generated
+585
-2800
File diff suppressed because it is too large
Load Diff
+9
-9
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "news-server",
|
"name": "news-server",
|
||||||
"version": "1.4.2",
|
"version": "1.7.1",
|
||||||
"description": "An API centric news server. Uses Sequelize and mariaDB by default.",
|
"description": "An API centric news server. Uses Sequelize and mariaDB by default.",
|
||||||
"main": "server/server.js",
|
"main": "server/server.js",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
@@ -13,21 +13,21 @@
|
|||||||
"url": "git+https://github.com/krgamestudios/news-server.git"
|
"url": "git+https://github.com/krgamestudios/news-server.git"
|
||||||
},
|
},
|
||||||
"author": "Kayne Ruse",
|
"author": "Kayne Ruse",
|
||||||
"license": "ISC",
|
"license": "Zlib",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://github.com/krgamestudios/news-server/issues"
|
"url": "https://github.com/krgamestudios/news-server/issues"
|
||||||
},
|
},
|
||||||
"homepage": "https://github.com/krgamestudios/news-server#readme",
|
"homepage": "https://github.com/krgamestudios/news-server#readme",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"cors": "^2.8.5",
|
"cors": "^2.8.5",
|
||||||
"dotenv": "^8.6.0",
|
"dotenv": "^16.4.5",
|
||||||
"express": "^4.17.1",
|
"express": "^4.19.2",
|
||||||
"jsonwebtoken": "^8.5.1",
|
"jsonwebtoken": "^9.0.2",
|
||||||
"mariadb": "^2.5.4",
|
"mariadb": "^3.3.0",
|
||||||
"markdown-it": "^12.3.0",
|
"markdown-it": "^14.1.0",
|
||||||
"sequelize": "^6.6.5"
|
"sequelize": "^6.37.3"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"nodemon": "^2.0.12"
|
"nodemon": "^3.1.0"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ const Sequelize = require('sequelize');
|
|||||||
|
|
||||||
const sequelize = new Sequelize(process.env.DB_DATABASE, process.env.DB_USERNAME, process.env.DB_PASSWORD, {
|
const sequelize = new Sequelize(process.env.DB_DATABASE, process.env.DB_USERNAME, process.env.DB_PASSWORD, {
|
||||||
host: process.env.DB_HOSTNAME,
|
host: process.env.DB_HOSTNAME,
|
||||||
|
port: process.env.DB_PORTNAME,
|
||||||
dialect: 'mariadb',
|
dialect: 'mariadb',
|
||||||
timezone: process.env.DB_TIMEZONE,
|
timezone: process.env.DB_TIMEZONE,
|
||||||
logging: process.env.DB_LOGGING ? console.log : false
|
logging: process.env.DB_LOGGING ? console.log : false
|
||||||
|
|||||||
+13
-8
@@ -1,5 +1,6 @@
|
|||||||
const express = require('express');
|
const express = require('express');
|
||||||
const router = express.Router();
|
const router = express.Router();
|
||||||
|
const cors = require('cors'); //route-by-route, because some routes are available without authentication
|
||||||
|
|
||||||
//middleware
|
//middleware
|
||||||
const authToken = require('../utilities/token-auth');
|
const authToken = require('../utilities/token-auth');
|
||||||
@@ -11,17 +12,21 @@ const edit = require('./edit');
|
|||||||
const remove = require('./remove');
|
const remove = require('./remove');
|
||||||
|
|
||||||
//basic route management (all query possibilities)
|
//basic route management (all query possibilities)
|
||||||
router.get('/', query(false, false));
|
router.get('/:id(\\d+)?', cors(), query(false, false));
|
||||||
router.get('/:id(\\d+)', query(false, false));
|
router.get('/archive/:id(\\d+)?', cors(), query(true, false));
|
||||||
router.get('/archive', query(true, false));
|
router.get('/metadata/:id(\\d+)?', cors(), query(false, true));
|
||||||
router.get('/archive/:id(\\d+)', query(true, false));
|
router.get('/archive/metadata/:id(\\d+)?', cors(), query(true, true));
|
||||||
router.get('/metadata', query(false, true));
|
|
||||||
router.get('/metadata/:id(\\d+)', query(false, true));
|
|
||||||
router.get('/archive/metadata', query(true, true));
|
|
||||||
router.get('/archive/metadata/:id(\\d+)', query(true, true));
|
|
||||||
|
|
||||||
//use middleware to authenticate the rest of the routes
|
//use middleware to authenticate the rest of the routes
|
||||||
|
router.use(cors({
|
||||||
|
credentials: true,
|
||||||
|
origin: [`${process.env.WEB_ORIGIN}`], //because auth-server
|
||||||
|
allowedHeaders: ['Origin', 'X-Requested-With', 'Content-Type', 'Accept', 'Authorization', 'Set-Cookie'],
|
||||||
|
exposedHeaders: ['Origin', 'X-Requested-With', 'Content-Type', 'Accept', 'Authorization', 'Set-Cookie'],
|
||||||
|
}));
|
||||||
|
|
||||||
router.use(authToken);
|
router.use(authToken);
|
||||||
|
|
||||||
router.use((req, res, next) => {
|
router.use((req, res, next) => {
|
||||||
if (req.user.mod) {
|
if (req.user.mod) {
|
||||||
next();
|
next();
|
||||||
|
|||||||
+41
-14
@@ -1,18 +1,45 @@
|
|||||||
const { Op } = require('sequelize');
|
|
||||||
const { articles } = require('../database/models');
|
const { articles } = require('../database/models');
|
||||||
|
|
||||||
//the query function that can be reused
|
//the query function that can be reused
|
||||||
const query = (ascending, metadataOnly) => async (req, res) => {
|
const query = (ascending, metadataOnly) => async (req, res) => {
|
||||||
|
if (process.env.QUERY_LIMIT) {
|
||||||
|
process.env.PAGE_SIZE = process.env.QUERY_LIMIT;
|
||||||
|
console.warn('The use of QUERY_LIMIT is deprecated. Please use PAGE_SIZE instead.');
|
||||||
|
}
|
||||||
|
|
||||||
|
if (req.query.limit) {
|
||||||
|
req.query.page_size = req.query.limit;
|
||||||
|
console.warn('The use of the limit parameter is deprecated. Please use page_size instead.');
|
||||||
|
}
|
||||||
|
|
||||||
|
const PAGE_SIZE = parseInt(req.query.page_size) || parseInt(process.env.PAGE_SIZE) || 999;
|
||||||
|
const PAGE = parseInt(req.query.page) || 1;
|
||||||
|
const ARTICLE_ID = req.params.id ? parseInt(req.params.id) : undefined;
|
||||||
|
const FIELDS = req.query.fields ? req.query.fields.split(',') : undefined;
|
||||||
|
|
||||||
|
const attributes = [
|
||||||
|
'index',
|
||||||
|
'author',
|
||||||
|
'createdAt',
|
||||||
|
'edits',
|
||||||
|
'title',
|
||||||
|
'updatedAt',
|
||||||
|
].concat(metadataOnly ? [] : [
|
||||||
|
'body',
|
||||||
|
'rendered'
|
||||||
|
]);
|
||||||
|
|
||||||
|
//filter out attributes that aren't requested
|
||||||
|
const attributesToFetch = FIELDS ? attributes.filter((attr) => {
|
||||||
|
return FIELDS.includes(attr) || attr === 'index';
|
||||||
|
}) : attributes;
|
||||||
|
|
||||||
//specific search (id is defined)
|
//specific search (id is defined)
|
||||||
if (req.params.id && typeof(parseInt(req.params.id)) === 'number') {
|
if (typeof(ARTICLE_ID) === 'number' && !isNaN(ARTICLE_ID)) {
|
||||||
const result = await articles.findOne({
|
const result = await articles.findOne({
|
||||||
attributes: [
|
attributes: attributesToFetch,
|
||||||
'index', 'title', 'author', 'edits', 'createdAt', 'updatedAt', ...(!metadataOnly ? ['body', 'rendered'] : [])
|
|
||||||
],
|
|
||||||
where: {
|
where: {
|
||||||
index: {
|
index: ascending ? ARTICLE_ID : (await articles.max('index') - ARTICLE_ID) + 1,
|
||||||
[Op.eq]: ascending ? parseInt(req.params.id) : (await articles.max('index')) - parseInt(req.params.id) + 1
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -23,16 +50,16 @@ const query = (ascending, metadataOnly) => async (req, res) => {
|
|||||||
//default search
|
//default search
|
||||||
else {
|
else {
|
||||||
const result = await articles.findAndCountAll({
|
const result = await articles.findAndCountAll({
|
||||||
attributes: [
|
attributes: attributesToFetch,
|
||||||
'index', 'title', 'author', 'edits', 'createdAt', 'updatedAt', ...(!metadataOnly ? ['body', 'rendered'] : [])
|
limit: PAGE_SIZE,
|
||||||
],
|
offset: Math.max((PAGE - 1) * PAGE_SIZE, 0),
|
||||||
order: [
|
order: [
|
||||||
['index', ascending ? 'ASC' : 'DESC']
|
['index', ascending ? 'ASC' : 'DESC']
|
||||||
],
|
]
|
||||||
limit: parseInt(req.query.limit) || parseInt(process.env.QUERY_LIMIT) || 999
|
|
||||||
});
|
});
|
||||||
|
|
||||||
return res.status(200).json(result.rows || result);
|
//result is empty array if failed to find
|
||||||
|
return res.status(200).json(result.rows || result || []);
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
+1
-46
@@ -5,11 +5,9 @@ require('dotenv').config();
|
|||||||
const express = require('express');
|
const express = require('express');
|
||||||
const app = express();
|
const app = express();
|
||||||
const server = require('http').Server(app);
|
const server = require('http').Server(app);
|
||||||
const cors = require('cors');
|
|
||||||
|
|
||||||
//config
|
//config
|
||||||
app.use(express.json());
|
app.use(express.json());
|
||||||
app.use(cors());
|
|
||||||
|
|
||||||
//database connection
|
//database connection
|
||||||
const database = require('./database');
|
const database = require('./database');
|
||||||
@@ -26,48 +24,5 @@ app.get('*', (req, res) => {
|
|||||||
server.listen(process.env.WEB_PORT || 3100, async (err) => {
|
server.listen(process.env.WEB_PORT || 3100, async (err) => {
|
||||||
await database.sync();
|
await database.sync();
|
||||||
console.log(`listening to localhost:${process.env.WEB_PORT || 3100}`);
|
console.log(`listening to localhost:${process.env.WEB_PORT || 3100}`);
|
||||||
|
console.log(`database located at ${process.env.DB_HOSTNAME || '<default>'}:${process.env.DB_PORTNAME || '<default>'}`);
|
||||||
//parse the unrendered data from the database
|
|
||||||
const markdownIt = require('markdown-it')();
|
|
||||||
const { articles, revisions } = require('./database/models');
|
|
||||||
|
|
||||||
const missingArticles = await articles.findAll({
|
|
||||||
where: {
|
|
||||||
rendered: ''
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
const missingRevisions = await revisions.findAll({
|
|
||||||
where: {
|
|
||||||
rendered: ''
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
await Promise.all(
|
|
||||||
missingArticles.map(async ma => {
|
|
||||||
ma.update({
|
|
||||||
rendered: markdownIt.render(ma.body)
|
|
||||||
}, {
|
|
||||||
where: {
|
|
||||||
index: ma.index
|
|
||||||
}
|
|
||||||
});
|
|
||||||
})
|
|
||||||
)
|
|
||||||
.then(result => {if (result.length > 0) console.log('Rendered articles in HTML'); })
|
|
||||||
;
|
|
||||||
|
|
||||||
await Promise.all(
|
|
||||||
missingRevisions.map(async mr => {
|
|
||||||
mr.update({
|
|
||||||
rendered: markdownIt.render(mr.body)
|
|
||||||
}, {
|
|
||||||
where: {
|
|
||||||
index: mr.index
|
|
||||||
}
|
|
||||||
});
|
|
||||||
})
|
|
||||||
)
|
|
||||||
.then(result => {if (result.length > 0) console.log('Rendered revisions in HTML'); })
|
|
||||||
;
|
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
#use this while debugging
|
#use this while debugging
|
||||||
CREATE DATABASE IF NOT EXISTS news;
|
CREATE DATABASE news;
|
||||||
CREATE USER IF NOT EXISTS 'news'@'%' IDENTIFIED BY 'venusaur';
|
CREATE USER 'news'@'%' IDENTIFIED BY 'venusaur';
|
||||||
GRANT ALL PRIVILEGES ON news.* TO 'news'@'%';
|
GRANT ALL PRIVILEGES ON news.* TO 'news'@'%';
|
||||||
|
|||||||
@@ -1,6 +0,0 @@
|
|||||||
use news;
|
|
||||||
ALTER TABLE revisions CHANGE COLUMN id `index` INTEGER(11) UNIQUE NOT NULL AUTO_INCREMENT;
|
|
||||||
|
|
||||||
ALTER TABLE revisions DROP FOREIGN KEY revisions_ibfk_1;
|
|
||||||
|
|
||||||
ALTER TABLE revisions CHANGE COLUMN originalIndex originalIndex INTEGER(11);
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
ALTER TABLE articles ADD COLUMN rendered TEXT DEFAULT "" AFTER body;
|
|
||||||
|
|
||||||
ALTER TABLE revisions ADD COLUMN rendered TEXT DEFAULT "" AFTER body;
|
|
||||||
|
|
||||||
Reference in New Issue
Block a user