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

Improving documentation for new developer contribution and local setup. #110

Open
arao opened this issue Aug 21, 2024 · 1 comment
Open

Comments

@arao
Copy link

arao commented Aug 21, 2024

This is a great addition of having compose-fullstacksample.yaml . This servers as very simple entry point to setup the entire service and have a look around. Though for those of who just started with this repo, facing following issues. It would be great if we can have some readme or guide on acquiring following placeholders.

  • #L22 INDEXER_MANAGER_API_KEY= CHANGE_TO_YOUR_APIKEY # How to get "CHANGE_TO_YOUR_APIKEY"
  • #L31 PROXY_DEBRID_STREAM_PASSWORD=CHANGE_ME # what should be the value of "CHANGE_ME"
  • A guide or reference around setup of "proxy" network via traefik. Also most of the traefik setup assume of having a domain, what is the recommended way to acquire one for local development ?

Expecting some guidance in this direction

Thanks

@Raislog
Copy link

Raislog commented Aug 21, 2024

How to get "CHANGE_TO_YOUR_APIKEY"- this changes based on if your indexer is prowlarr or jackett. For example - Jackett's api key is displayed at the top of your user dashboard once you bring it online.

what should be the value of "CHANGE_ME" - This is you setting your own password.....

setup of "proxy" network via traefik -- labels included in the compose file does a pretty good job of including what you would need for this stack. The things missing would be traefik itself, and you configuring your own ACME challenge. There's different ways to do that, and there are projects people made out there to 'build' a traefik network from scratch (Auto-Traefik). You just have to search around.

Pick a DNS provider for your domain. Search around for best deal. They're all slightly different.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants