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

[feature request] Allow disabling the REST API #126

Closed
cole-h opened this issue Jan 12, 2024 · 7 comments
Closed

[feature request] Allow disabling the REST API #126

cole-h opened this issue Jan 12, 2024 · 7 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@cole-h
Copy link

cole-h commented Jan 12, 2024

Feature Request

Use Case:

I use process-compose in a couple of projects. However, the REST API process-compose exposes conflicts with both itself (when trying to run multiple instances of process-compose in different projects) and with other software (i.e. webservers that bind to 8080 locally, the default REST API port).

Proposed Change:

I would like a way to completely disable the REST API webserver that comes with process-compose -- I don't need it.

Who Benefits From The Change(s)?

Anybody who wants to use process-compose in multiple projects at the same time.

Alternative Approaches

None.

@cole-h cole-h changed the title Allow disabling the REST API [feature request] Allow disabling the REST API Jan 12, 2024
@F1bonacc1
Copy link
Owner

Hi @cole-h,

Have you considered, as an alternative, specifying a different port for each instance of Process Compose with -p flag or the PC_PORT_NUM environment variable?

@cole-h
Copy link
Author

cole-h commented Jan 12, 2024

I have, but it is quite inconvenient to remember to do that whenever I start using process-compose in a new project (for me, this is more frequent than you may think). I'll try to start it up, but it just silently exits with status code 1 and no output.

It's very convenient being able to run process-compose and get a working environment with all my required background processes without needing to remember to specify a flag or environment variable.

@F1bonacc1
Copy link
Owner

Will something like --no-server flag that you will be able to add to your Process Compose alias, work for you?

@cole-h
Copy link
Author

cole-h commented Jan 12, 2024

Yes it would! If I may be greedy, I'd also appreciate an environment variable. (It's easier to set a global environment variable that disables the server altogether than it is to set lots of scoped environment variables to change the port.)

@F1bonacc1
Copy link
Owner

Sure, it's almost the same effort to add them both.

@F1bonacc1 F1bonacc1 added enhancement New feature or request good first issue Good for newcomers labels Jan 13, 2024
@F1bonacc1
Copy link
Owner

Added in v0.80.0

@cole-h
Copy link
Author

cole-h commented Jan 16, 2024

Thanks a ton for being amenable and for the quick turnaround! I really appreciate it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants