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 role: Membarr #257

Merged
merged 4 commits into from
Aug 24, 2023
Merged

Add role: Membarr #257

merged 4 commits into from
Aug 24, 2023

Conversation

RaneyDazed
Copy link
Contributor

Description

Will create docs for it if it gets that far. I was hoping someone could give this a once over, as I'm struggling to figure out if I'm doing something wrong or if the bot/role itself is the problem.

How Has This Been Tested?

I've tested it on my home server and my feederbox. It connects fine to discord and the bot works and responds well. Everything looks good there. Only issue is it doesn't seem to want to connect to plex and I need someone or a few people to test it for me maybe? Thanks!

The code changes include the addition of Membarr's default variables and the creation/removal of Docker container directories, and creating the Docker container.
This commit adds a discord_token field to Membarr settings in defaults/settings.yml.default file. The configuration change enables users to set up their Discord bot token in Membarr.
This commit refactors the membarr application to use the default Discord token. The docker run command has been updated to include new environment variables, and the role's main task now checks for a specified default Discord token and fails when not specified.
@RaneyDazed RaneyDazed mentioned this pull request May 9, 2023
@RaneyDazed
Copy link
Contributor Author

should this be converted to a draft?

@RaneyDazed
Copy link
Contributor Author

so after figuring out how it works, I'll have to create docs for it regardless because its not documented well in the first place. anyone who decides to take a look at it, please lmk what you think, the container creates the config.ini file on its own, but I can create a jinja template that will fill in the plex details. the thing is, if this is installed on a separate saltbox server IE feeder, there won't be a plex url. so IG best way to do it is to just document how to set it up yeah? or we could add it to settings.yml, but iirc you all wanted to step away from that..?

either way, it works as intended right now, just gotta fill in relevant info in a file.

@ifelsee101
Copy link

ifelsee101 commented May 18, 2023

@RaneyDazed Thanks for creating this role. I was able to test this, and it works as expected after adding 'plex_base_url = http://plex:32400' to the config.ini file. Setting up through discord channel added a weird long url to plex_base_url, I changed it to above and it worked fine.

@keldian
Copy link
Contributor

keldian commented May 18, 2023

Make a template for the config file. For the Plex URL, use plex_web_url—don't hardcode it.

If the token can't be passed via the config file, use an env file instead of settings.yml (check Watchtower for inspiration).

@maximuskowalski
Copy link
Collaborator

Is a template being made for this @RaneyDazed?

@RaneyDazed
Copy link
Contributor Author

RaneyDazed commented Jul 21, 2023

will be messing with this in a bit! Sorry its taken so long. I forgot about it after I read the notification.

- Added membarr_paths_recursive variable to allow recursive creation of directories in membarr role.
- Added membarr_paths_config_location variable to specify the location of config.ini file in membarr role.
- Created new subtask settings.yml to handle all the settings related tasks in membarr role.
- Added import task to include the settings.yml subtask in the main tasks of membarr role.
- Created config.ini.j2 template file to define the configuration options for membarr.
@RaneyDazed
Copy link
Contributor Author

Still working on it, about done with the template and I'll test it out on a box or two. @keldian @maximuskowalski

@RaneyDazed
Copy link
Contributor Author

Still working on it, about done with the template and I'll test it out on a box or two. @keldian @maximuskowalski

Well the template and subtask

@RaneyDazed
Copy link
Contributor Author

Should be all set..?

@maximuskowalski
Copy link
Collaborator

Docs PR all that we need then and ready to go?

@RaneyDazed
Copy link
Contributor Author

Yup thats correct! although i was unaware it was waiting for a Docs pr before it would be approved. I'd have done that ages ago. I just didn't want to bother if it wasn't going to be approved. But I can write up some docs!

@maximuskowalski
Copy link
Collaborator

Everything needs docs before it will be merged now.

@maximuskowalski maximuskowalski added the documentation needed waiting on documentation PR label Aug 12, 2023
@maximuskowalski
Copy link
Collaborator

saltyorg/docs#205

@maximuskowalski maximuskowalski merged commit 4a89854 into saltyorg:master Aug 24, 2023
owine pushed a commit that referenced this pull request Aug 30, 2023
* Create Membarr Docker Container with Default Variables

The code changes include the addition of Membarr's default variables and the creation/removal of Docker container directories, and creating the Docker container.

* Add discord token to Membarr configuration in settings.yml.default

This commit adds a discord_token field to Membarr settings in defaults/settings.yml.default file. The configuration change enables users to set up their Discord bot token in Membarr.

* "Refactor membarr (main): Update default Discord token usage"

This commit refactors the membarr application to use the default Discord token. The docker run command has been updated to include new environment variables, and the role's main task now checks for a specified default Discord token and fails when not specified.

* feat: Add membarr_paths_recursive and membarr_paths_config_location

- Added membarr_paths_recursive variable to allow recursive creation of directories in membarr role.
- Added membarr_paths_config_location variable to specify the location of config.ini file in membarr role.
- Created new subtask settings.yml to handle all the settings related tasks in membarr role.
- Added import task to include the settings.yml subtask in the main tasks of membarr role.
- Created config.ini.j2 template file to define the configuration options for membarr.
@RaneyDazed RaneyDazed deleted the add-membarr branch February 3, 2024 22:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation needed waiting on documentation PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants