diff --git a/README.md b/README.md index 903d3f7..8b94f5c 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,11 @@ -# Enstrayed API -This repository contains the code for my personal web API written in JavaScript using the Express framework. - -## Documentation -This file contains documentation relevant for development and deployment, but not necessarily usage. Information for all endpoints is available [on my website](https://enstrayed.com/posts/20240409-API-Documentation.html). - -## Issues -If you would like to report a bug or security issue, please open a GitHub issue. If you are the operator of a service this application accesses, use the contact information provided during registration with your service to contact me directly. +## Note for Visitors +* This README mainly contains information for operation but not usage. API documentation is available [here](https://enstrayed.com/posts/20240409-API-Documentation.html). +* Have feedback or experiencing a problem with an endpoint? Please [open a GitHub issue](https://github.com/Enstrayed/enstrayedapi/issues/new). +* Security problem? [Open a ticket here](https://helpdesk.enstrayed.com/open.php) with the topic set as 'Responsible Disclosure'. +* This code is unlicensed but I don't really care if you use parts of it (I don't know why you would though). ## Configuration - +TODO: Rewrite
Configuration Template @@ -19,7 +16,7 @@ If you would like to report a bug or security issue, please open a GitHub issue.
## Docker -In production, this application is designed to be run in Docker, and the container built by pulling the latest commit from the main branch. As such, deploying this application is just a matter of creating a directory and copying the Dockerfile: +TODO: Rewrite & add Komodo TOML files ```dockerfile FROM node:22 @@ -38,7 +35,4 @@ ENTRYPOINT [ "node", "index.js" ] ``` - - -## License -If for whatever reason you want to, you are free to adapt this code for your own projects or as reference. However, this software is provided as-is with no warranty or agreement to support it. \ No newline at end of file + \ No newline at end of file diff --git a/routes/frontpage.js b/routes/frontpage.js index 1682a47..4328ba5 100644 --- a/routes/frontpage.js +++ b/routes/frontpage.js @@ -7,7 +7,7 @@ import { marked } from "marked" var timeSinceLastQuery = Date.now()-10000 var cachedResult = "" -app.get("/", (rreq, rres) => { +app.get("/indexbeta", (rreq, rres) => { if (Date.now() < timeSinceLastQuery+10000) { rres.send(cachedResult) } else { @@ -17,6 +17,10 @@ app.get("/", (rreq, rres) => { } }) +app.get("/", (rreq, rres) => { + rres.sendFile(process.cwd()+"/website/templates/construction.html") +}) + app.get("/static/*", (rreq,rres) => { rres.sendFile(process.cwd()+"/website/static/"+rreq.url.replace("/static/","")) }) diff --git a/todo.md b/todo.md deleted file mode 100644 index 27281b2..0000000 --- a/todo.md +++ /dev/null @@ -1,7 +0,0 @@ -- [ ] GET /api/whoami - Returns owner of token and what scopes it has -- [ ] GET /api/login - OIDC login redirect to ECLS -- [ ] GET /api/callback - Creates new token that is intended to be local to browser; e.g. can be used in turn to make longer lasting more specific tokens -- [ ] POST /api/token - Allows owner to create a new token with customized scopes, comments & expiration date -- [ ] DELETE /api/token - Invalidate a token -- [ ] liberals/libnowplaying - Implement queryCider() -- [ ] routes/nowplaying - Reimplement query order to Cider and then Jellyfin diff --git a/website/static/construction.svg b/website/static/construction.svg new file mode 100644 index 0000000..476d46b --- /dev/null +++ b/website/static/construction.svg @@ -0,0 +1,152 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/website/templates/construction.html b/website/templates/construction.html new file mode 100644 index 0000000..658f7c2 --- /dev/null +++ b/website/templates/construction.html @@ -0,0 +1,42 @@ + + + + + + Under Construction + + + +
+ Construction Icon +

Under Construction

+

+ This page is undergoing a revamp and will be available again soon.
+ All API endpoints are still available. Documentation is available here. +

+
+ + \ No newline at end of file