elias/vdo.ninja
1
0
Fork 0
mirror of https://github.com/eliasstepanik/vdo.ninja.git synced 2026-01-14 23:28:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update install.md

Browse Source
This commit is contained in:
Steve Seguin 2021-07-15 06:20:33 -04:00 committed by GitHub
parent f1fb66fd03
commit 0addef063c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
install.md
View File

@ -93,7 +93,13 @@ A newly deployed code deployment should work without any changes to the index.ht
My suggestion? Limit changes to images and perhaps the translation files (maybe add a new one); these are good starting points. If making changes to the main.css style sheet or index.html file, you should be mostly okay too, since these files are designed to be changed; I try to keep that in mind when updating the code at least. Making changes to other files though is strongly not recommend and in some cases discouraged. If you find a bug or need to make a change to other files, it might be best to make a Pull Request with the desired changes and hope it gets adopted into the main codebase.
Final note: I haven't provided here instructions on deploying STUN services or a private handshake server; the VDO.Ninja handshake server code is currently not provided, but access to it as a service is freely accessible for private deployments.
For those looking to deploy a completely Internet-free option, you'll need to deploy your own STUN services and a handshake server.
There is an experimental option that lets advanced users use a basic/generic websocket service as a personal handshake server; useful for air-gapped private deployments of the service. A simple socket server has been developed that can be used as a personal handshake server. Documentation with installation instructions included here: https://github.com/steveseguin/websocket_server
Support for piesocket.com has also been added as a third-party handshake-server service option. If using piesocket, you can just do &pie=APKKEY to use that service, without deploying any code or servers yourself. The free tier is quite generous and I have no affiliation with them.
Details on how to deploy your own private STUN server can be Googled online; it's rather out of the scope of this guide's goals.
Regards,
Steve