m-expunged / guacamole-sharp

C# replacement of the Apache Guacamole server-side Java servlet.
Apache License 2.0
26 stars 3 forks source link

How to run #12

Closed ivan127617 closed 1 year ago

ivan127617 commented 2 years ago

Hello, I am a beginner of Asp.net. I don't know how to run this project, can you be more specific, or is there a video? Thank you very much!

m-expunged commented 2 years ago

You should be able to run the project locally through Visual Studio or the dotnet run command right after cloning it. It'll open a browser window with Swagger that'll show you the available API endpoints. Guacd needs to run as well, ofc.

Using Docker, there isn't much more to it than what's already in the README. No need to even clone the project if you are using Docker. You can just run the commands in the README then test the endpoints with e.g. Postman. In case you want to build the Docker image yourself, I'd use the docker-compose file in the repository as a starting point.

You can also deploy it using e.g. IIS, but you'll have to figure that out for yourself, since there's a lot of use specific fiddling required there. I might write an example deploy later, no promises tho.

ivan127617 commented 2 years ago

I really appreciate it