GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GitHub - UniversalMediaServer/api: The metadata API that the Universal Media Server application uses

BranchesTags
Open more actions menu

Latest commit

 

History

2,126 Commits
2,126 Commits

Folders and files

NameName
Last commit message
Last commit date
.github
.github
 
 
.vscode
.vscode
 
 
.yarn/releases
.yarn/releases
 
 
src
src
 
 
test
test
 
 
.gitignore
.gitignore
 
 
.nvmrc
.nvmrc
 
 
.yarnrc.yml
.yarnrc.yml
 
 
README.md
README.md
 
 
ecosystem.config.js
ecosystem.config.js
 
 
eslint.config.mjs
eslint.config.mjs
 
 
jest.config.cjs
jest.config.cjs
 
 
nodemon.json
nodemon.json
 
 
openapi.yaml
openapi.yaml
 
 
package.json
package.json
 
 
renovate.json
renovate.json
 
 
sequence.puml
sequence.puml
 
 
tsconfig.json
tsconfig.json
 
 
yarn.lock
yarn.lock
 
 

Repository files navigation

UMS API Build Status

Development

The required Node.js and Yarn versions are listed in the package.json file.

You can run nvm use and yvm use from the project root if you have Node version manager and Yarn version managers installed to select the correct version.

Environment variables

  • MONGO_URL URL to a running Mongo instance which includes user and password
  • BYPASS_MONGO if set to "true", will drop the database on each request, to get fresh data from external APIS. Use with caution.
  • UMS_API_PRIVATE_KEY_LOCATION and UMS_API_PUBLIC_KEY_LOCATION optional absolute locations of SSL keys for HTTPS

Commands

yarn watch

Watches for changes to TypeScript files and compiles them to JavaScript (use yarn run build to do it manually)

yarn dev

Runs the development server and restarts it when any file is changed

yarn dev:cron

Runs the cron job feature using ts-node

yarn start

Runs the server

yarn test

Runs the test suite

yarn run start:prod

Starts the API and cron job in production mode. TypeScript files are compiled in memory on application start.

Logs

To view the production logs:

  1. Run sudo sh -c "du -ch /var/lib/docker/containers/*/*-json.log" to print the list of logs. Look for the biggest one and copy the container ID.
  2. Run docker logs -f --tail 100 CONTAINER_ID

Troubleshooting

If the production server is unstable, it could be because the Docker cache is filling the hard drive. To fix it, run docker system prune -a to clear unused stuff.

About

The metadata API that the Universal Media Server application uses

Topics

mongodbmongoosenodejstypescript

Resources

Readme
Activity
Custom properties

Stars

12 stars

Watchers

6 watching

Forks

3 forks
Report repository

Used by

Contributors

Languages

You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.