Skip to content
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

Add my Navidrome Music Streaming Egg #12

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@

* [Meilisearch](/meilisearch)

### Navidrome

* [Navidrome](/navidrome)

### Owncast

* [owncast](/owncast)
Expand Down
6 changes: 6 additions & 0 deletions navidrome/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Navidrome Egg for Pterodactyl
A music Streaming Service as an Pterodactyl Egg

[GitHub Repository](https://github.com/devilAPI/navidrome-music-streaming-pterodactyl-egg).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should link to the software source. Not where you host your egg.


Just import it into Pterodactyl, change the "Port" value on the "Startup" page and you're good to go!
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where is the required ports table?

142 changes: 142 additions & 0 deletions navidrome/egg-navidrome.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
{
"_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO",
"meta": {
"version": "PTDL_v2",
"update_url": null
},
"exported_at": "2024-12-27T22:06:30+01:00",
"name": "Navidrome",
"author": "[email protected]",
"description": "Navidrome Music Server - A lightweight music server for your personal collection.",
"features": null,
"docker_images": {
"devilapi\/navidrome-pterodactyl:latest": "devilapi\/navidrome-pterodactyl:latest"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not allowed. The image must be owned by pelican. So please pr it if it meeds the requirements

},
"file_denylist": [],
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Startup script is also not allowed for security reasons.

"startup": "\/bin\/bash \/home\/container\/start.sh",
"config": {
"files": "{\r\n}",
"startup": "{\r\n \"done\": \"Navidrome is ready to accept requests\"\r\n}",
"logs": "{\r\n \"logs\": {\r\n \"stdout\": \"\/home\/container\/logs\/stdout.log\",\r\n \"stderr\": \"\/home\/container\/logs\/stderr.log\"\r\n }\r\n}",
"stop": "^C"
},
"scripts": {
"installation": {
"script": "mkdir \/mnt\/server\/music",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on this I assume the files are in the image. This is not allowed. The install script should download them. The image should only hold pacakges.

"container": "alpine:3.4",
"entrypoint": "ash"
}
},
"variables": [
{
"name": "Navidrome BaseURL",
"description": "Base URL for Navidrome",
"env_variable": "ND_BASEURL",
"default_value": "",
"user_viewable": true,
"user_editable": true,
"rules": "required|string|max:60",
"field_type": "text"
},
{
"name": "Data Folder",
"description": "",
"env_variable": "ND_DATAFOLDER",
"default_value": "\/home\/container\/data",
"user_viewable": true,
"user_editable": true,
"rules": "required|string|max:60",
"field_type": "text"
},
{
"name": "Navidrome Music Folder",
"description": "",
"env_variable": "ND_MUSICFOLDER",
"default_value": "\/home\/container\/music",
"user_viewable": true,
"user_editable": true,
"rules": "required|string|max:60",
"field_type": "text"
},
{
"name": "Port",
"description": "",
"env_variable": "ND_PORT",
"default_value": "4533",
"user_viewable": true,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this the only needed port then please use the build in SERVER_PORT var

"user_editable": true,
"rules": "required|int|max:65535",
"field_type": "text"
},
{
"name": "Spotify Dev ID",
"description": "Your Spotify Developer ID for Spotify Integration.",
"env_variable": "ND_SPOTIFY_ID",
"default_value": "",
"user_viewable": true,
"user_editable": true,
"rules": "required|string|max:80",
"field_type": "text"
},
{
"name": "Spotify Dev Secret",
"description": "",
"env_variable": "ND_SPOTIFY_SECRET",
"default_value": "",
"user_viewable": true,
"user_editable": true,
"rules": "required|string|max:80",
"field_type": "text"
},
{
"name": "LastFM API Key",
"description": "",
"env_variable": "ND_LASTFM_APIKEY",
"default_value": "",
"user_viewable": true,
"user_editable": true,
"rules": "required|string|max:80",
"field_type": "text"
},
{
"name": "LastFM API Secret",
"description": "",
"env_variable": "ND_LASTFM_SECRET",
"default_value": "",
"user_viewable": true,
"user_editable": true,
"rules": "required|string|max:280",
"field_type": "text"
},
{
"name": "Log Level",
"description": "Useful for troubleshooting. Possible values: error, warn, info, debug, trace",
"env_variable": "ND_LOGLEVEL",
"default_value": "info",
"user_viewable": true,
"user_editable": true,
"rules": "required|string|max:5",
"field_type": "text"
},
{
"name": "Config File Location",
"description": "",
"env_variable": "ND_CONFIGFILE",
"default_value": "",
"user_viewable": true,
"user_editable": true,
"rules": "string|max:20",
"field_type": "text"
},
{
"name": "Enable Insights Collector",
"description": "Controls whether the server will run its Anonymous Data Collection feature to help improve the project.",
"env_variable": "ND_ENABLEINSIGHTSCOLLECTOR",
"default_value": "0",
"user_viewable": true,
"user_editable": true,
"rules": "required|boolean|max:20",
"field_type": "text"
}
]
}