socketry / falcon

A high-performance web server for Ruby, supporting HTTP/1, HTTP/2 and TLS.
https://socketry.github.io/falcon/
MIT License
2.57k stars 79 forks source link

Write a documentation about configuration #127

Open AlexWayfer opened 4 years ago

AlexWayfer commented 4 years ago

Hello.

I see a small documentation about how it works, how to change a port, what it uses. But I don't understand, can I specify UNIX socket instead of port, number of workers or whatever, and how to do these things. Should I use CLI options or there is a support for configuration file.

ioquatix commented 4 years ago

I will update the documentation.

AlexWayfer commented 3 years ago

BTW, right now it looks like the most liked issue. 🤐

And I still don't want to migrate my Rack-based framework to this server due to lack of documentation. I'm not meaning "my framework is very important!", I'm meaning "it's a really issue with real case".

ioquatix commented 3 years ago

Yes, understood.

ylecuyer commented 3 years ago

I came here to create the same ticket as I only tried to run it locally to poke with it. I was only able to run it as included in the rails app (default server) or with falcon serve once you want to poke with falcon host documentation doesn't exist, it only says read the source code :man_shrugging:

Regarding source code it is not easy to read as I'm not accustomed to the structure of the project and it relies heavily on externals gems which are not well documented either and you always have to switch from one project to another to kind of understand what is going under the hood which is sad.

luizkowalski commented 3 years ago

Hey, Is this issue still relevant? I stumbled upon Falcon on Reddit and would like to give it a try on our staging environment but I really would like first to see an overview of all the configs available on falcon.rb file. I read the documentation, dig though the examples folder but it still unclear to me.

ioquatix commented 3 years ago

It could be clearer but all the environment configurations are described here: https://socketry.github.io/falcon/source/Falcon/Environments/index.html