Package Health Score

48 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Sustainable

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
0.1.3	\|	09/2022	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (0)

GitHub Stars: 81
Forks: 32
Contributors: 20

Direct Usage Popularity

The npm package janus-presence-server receives a total of 0 downloads a week. As such, we scored janus-presence-server popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package janus-presence-server, we found that it has been starred 81 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the janus-presence-server repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like janus-presence-server is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 3
Open PR: 3
Last Release: 2 years ago
Last Commit: 1 year ago

Further analysis of the maintenance status of janus-presence-server based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for janus-presence-server is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 3 years
Dependencies: 16 Direct
Versions: 4
Install Size: 63.8 kB
Dist-tags: 1
# of Files: 31
Maintainers: 1
TS Typings: No

janus-presence-server has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Janus VR Presence Server

This version is the one that VR Sites runs, which is the default server unless another is specified in your `` code. Read here to learn how your room can specify a different server.

Introduction

The Janus VR Presence Server is an open source project started by Lisa Croxford which allows one JanusVR client to share information with another client. It enables multiplayer. The server software is what allows each of the JanusVR clients know where other avatars are geographically and who else is in the same virtual space. It is also what enables things like chat.

If you need more information or would like to get involved, you will find most JanusVR enthusiasts on the JanusVR subreddit. You can also read the CONTRIBUTORS.md file in the root of this repository.

If you want to understand how a client interacts with the Janus VR Presence Server then checkout the API Documentation.md in the root of this repository.

Installation

Download and install node from nodejs.org
Clone this repo or download the latest release via the releases page on GitHub.
cd into the root of the repository where server.js is located and run npm install to install all module dependencies listed in package.json. The modules will be placed into the node_modules folder and are required for the server to start.
Copy config-example.js to config.js and change any of the variables you require to run your server. It's fairly well commented to guide you.

SSL

SSL is not required to run your server, but it is recommended. At the very least you should go through the self-signed SSL process outlined below.

Self-signed SSL

Run the ./generate_key script in the root of the repository to generate a SSL certificate for the server.

When asked to provide a Common Name for the server enter the domain name the server will be running on. I.e. yourdomain.com. If running a development version of the server on OSX you can also use your Bonjour name i.e. yourcomputer.local. On OSX you can see your computer's Bonjour name by going to System Preferences -> Sharing and looking under the Computer Name field.
When asked to provide a challenge password while generating the SSL certificate press enter to skip setting a password.

Certified SSL

If you have a valid SSL certificate:

Save the key file as cert/server-key.pem
Save the certificate file as cert/server-cert.pem
Save your CA's intermediate certificates as cert/cabundle.pem

Running the Server

cd to the root of the repository where server.js is located.
Run the following command to start the server: node server.js. If you want this to run continually, you may want to look into using forever or pm2 which are node modules built specifically for running other node server applications.
Launch the JanusVR client with paramters to connect to your server.

Windows Create a shortcut to JanusVR and add the following arguments after the path to the JanusVR executable
- -server my.server.com -port 5566 where my.server.com is the IP address of your computer (127.0.0.1 or localhost should also work here) and where 5566 is the port that the server is running on as defined in config.js.
OSX You can run the client from the command line by navigating to janusvr.app/Contents/MacOS/ and running
- ./janusvr -server my.server.com -port 5566 for non-ssl
- ./janusvr -server my.server.com -port 5567 for ssl

Contributing

We have a contributors guide in the CONTRIBUTORS.md file found in this directory.

Troubleshooting

> I cannot see other people when using JanusVR and I know others have the same server configured.

Press / once JanusVR has started. JanusVR will list all the servers you are trying to connect to or ARE connected to. You should see your server in this list. If your server is red then it means that JanusVR cannot connect to it. Check firewall settings on the server to make sure that port 5566 and 5567 (for SSL) are open and able to receive traffic. Check the server.log file on the server to see if there are any errors.

> I entered the wrong details in for my key after executing ./generate_key.

./generate_key will generate 3 files based on your input:

/cert/server-key.pem
/cert/server-cert.pem
/cert/cabundle.pem
Just delete these and execute './generate_key' again.

> I have a general problem and need some troubleshooting info about the server application.

Check out the server.log file. Just tail it and you will see the log being written to as activities take place - e.g. logging on etc.

License

This project is licensed under the MIT license. See the LICENSE.txt file in this directory for complete text.

janus-presence-server dependencies

body-parser byline express finished http-string-parser janus-method-ping janus-mysql-auth janus-mysql-popular janus-mysql-userlist-official mysql npmlog optimist redis simplesets split-ca websocket-driver

janus-presence-server development dependencies

chai janus-node-client mocha superagent websocket

FAQs

What is janus-presence-server?

JanusVR presence and chat server. Visit Snyk Advisor to see a full health score report for janus-presence-server, including popularity, security, maintenance & community analysis.

Is janus-presence-server popular?

We’re still processing downloads data for the npm package janus-presence-server. Visit the popularity section on Snyk Advisor to see the full popularity analysis.

Is janus-presence-server well maintained?

We found indications that janus-presence-server is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is janus-presence-server safe to use?

The npm package janus-presence-server was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 7 November-2024, at 14:44 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (0)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Janus VR Presence Server

Introduction

Installation

SSL

Self-signed SSL

Certified SSL

Running the Server

Contributing

Troubleshooting

License

janus-presence-server dependencies

janus-presence-server development dependencies

FAQs

What is janus-presence-server?

Is janus-presence-server popular?

Is janus-presence-server well maintained?

Is janus-presence-server safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues