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

Docs improve #284

Closed
wants to merge 5 commits into from
Closed

Docs improve #284

wants to merge 5 commits into from

Conversation

stokito
Copy link

@stokito stokito commented Dec 15, 2023

This changes would safe me time. Easy to build with make build and run a demo.
Docs made more clear.

Split plugins into two lists. The RESTful plugin listed in both.

Add an example of Pubkey auth for upstream.
Also added a pre-generated keys to make it easier for local development.

Minor typo fixes and improvements
@tg123
Copy link
Owner

tg123 commented Dec 17, 2023

thanks for the pr

1 makefile is good, but have to keep it up to date. current build is via gorelease, any future update may make makefile stale.
2 key can be generated via --server-key-generate-mode=notexist, no need to put a fake key in the repo
3 maybe using docker-compose to start a demo if doc is not clear enough

@stokito
Copy link
Author

stokito commented Dec 17, 2023

The makefile is really just same steps as described in the readme.
It's main goal is to build plugins but then debug in Goland.
The goreleaser is an additional tool to install and learn which I don\t need for now.

I just made changes that might simplify learning for me

@tg123
Copy link
Owner

tg123 commented Dec 18, 2023

there is a devcontainer.json for vscode, i do not have goland not sure if makefile is required
but i am open to add makefile, as building plugins need too many args to go build

integrate makefile with https://github.com/tg123/sshpiper/blob/master/Dockerfile#L12?

@stokito
Copy link
Author

stokito commented Dec 18, 2023

Well, the purpose of the Makefile is just to show a simplest commands to build it locally. No need to integrate to with Docker. It can be just as an option.
If you feel not comfortable with it then you can skip the last commit

@tg123
Copy link
Owner

tg123 commented Dec 19, 2023

i mean call make inside dockerfile to ensure makefile is up to date

@stokito
Copy link
Author

stokito commented Dec 19, 2023

Not sure, but rather no. They are used for different purposes.

@tg123 tg123 closed this May 18, 2024
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

Successfully merging this pull request may close these issues.

None yet

2 participants