-
Notifications
You must be signed in to change notification settings - Fork 227
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Remove unnecessary submodules from tools directory #2196
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,3 @@ | ||
[submodule "libs/oboe"] | ||
path = libs/oboe | ||
url = ../../google/oboe.git | ||
[submodule "tools/jamulus-php"] | ||
path = tools/jamulus-php | ||
url = ../../softins/jamulus-php | ||
[submodule "tools/jamulus-web"] | ||
path = tools/jamulus-web | ||
url = ../../softins/jamulus-web | ||
[submodule "tools/jamulus-wireshark"] | ||
path = tools/jamulus-wireshark | ||
url = ../../softins/jamulus-wireshark | ||
[submodule "tools/jamulus-historytool"] | ||
path = tools/jamulus-historytool | ||
url = ../../pljones/jamulus-historytool | ||
[submodule "tools/jamulus-jamexporter"] | ||
path = tools/jamulus-jamexporter | ||
url = ../../pljones/jamulus-jamexporter | ||
[submodule "tools/jamulus-docker"] | ||
path = tools/jamulus-docker | ||
url = ../../grundic/jamulus-docker | ||
[submodule "tools/jamulus-server-remote"] | ||
path = tools/jamulus-server-remote | ||
url = ../../vdellamea/jamulus-server-remote |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# Other projects related to Jamulus | ||
|
||
This document lists a number of third-party projects related to Jamulus, which users may find interesting. | ||
|
||
## jamulus-php | ||
|
||
[jamulus-php](https://github.com/softins/jamulus-php) implements a simplified Jamulus client in a | ||
PHP web server, which knows enough Jamulus protocol to fetch the list of registered servers from a | ||
directory, and a list of active clients from each registered server. It returns the results in JSON | ||
for display by a front end, such as [Jamulus Explorer](https://explorer.jamulus.io) | ||
or [Jamulus Live](https://jamulus.live/). | ||
|
||
## jamulus-web | ||
|
||
[jamulus-web](https://github.com/softins/jamulus-web) implments the front end used by | ||
the [Jamulus Explorer](https://explorer.jamulus.io) web site, which allows a web | ||
browser to be used to view the public server directories and the servers that are | ||
registered to them. | ||
|
||
## jamulus-wireshark | ||
|
||
[jamulus-wireshark](https://github.com/softins/jamulus-wireshark) is a protocol dissector | ||
plugin for Wireshark, to enable Wireshark to understand the structure of the Jamulus protocol | ||
and display it in a user-friendly way. It is implemented in LUA. | ||
|
||
## jamulus-historytool | ||
|
||
[jamulus-historytool](https://github.com/pljones/jamulus-historytool) comprises two scripts: | ||
* A PHP script to parse the Jamulus log file and emit it as a JSON response | ||
* A JS script to parse the JSON response and emit an SVG DOM node | ||
|
||
This replaces the History Graph that used to be part of the Jamulus server itself. | ||
|
||
## jamulus-jamexporter | ||
|
||
[jamulus-jamexporter](https://github.com/pljones/jamulus-jamexporter) comprises two scripts: | ||
* A bash script to monitor the Jamulus recording base directory for new recordings | ||
* A bash script to apply some judicious rules and compression before uploading the recordings offsite | ||
|
||
## jamulus-docker | ||
|
||
[jamulus-docker](https://github.com/grundic/jamulus-docker) is an implementation of Jamulus | ||
within a Docker container. It provides a `Dockerfile` and some documentation. | ||
|
||
## jamulus-server-remote | ||
|
||
[jamulus-server-remote](https://github.com/vdellamea/jamulus-server-remote) provides a lightweight | ||
web front-end for a headless Jamulus server running on Linux. It allows a user to start and stop recordings, | ||
and to zip them up and download them via a web browser. It is implemented in PHP. |
Submodule jamulus-docker
deleted from
c268ce
Submodule jamulus-historytool
deleted from
d5ef80
Submodule jamulus-jamexporter
deleted from
f89fec
Submodule jamulus-php
deleted from
65be50
Submodule jamulus-server-remote
deleted from
b6387d
Submodule jamulus-web
deleted from
211247
Submodule jamulus-wireshark
deleted from
593bf4
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are you sure you want to add this to the main repo? Maybe it would be better to have it as a post in the community KB on the website.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe. I just didn't want to completely remove information from the repo, so I created this document as somewhere to put it. If we moved it to the web site and removed it from here, people cloning the repo might not know the information is available to be found elsewhere. I don't always find things easy to locate on the website.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some advanced stuff is quite hidden… probably worth re-organising the site?
Personally, I‘d prefer to have documentation on the website, but it’s up to you where to put it.
Asking for another opinion:
@gilgongo should we move this document to the website?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Might be nice to have it them on the website. Can't immediately think where though - perhaps as page linked out from the client and server manuals?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Community KB?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suppose since these projects are a) subject to change out of our control and b) not core core information about Jamulus, then they would be a candidate for the KB, yes.