falcon icon indicating copy to clipboard operation
falcon copied to clipboard

Write a documentation about configuration

Open AlexWayfer opened this issue 4 years ago • 6 comments

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.

AlexWayfer avatar Aug 17 '20 12:08 AlexWayfer

I will update the documentation.

ioquatix avatar Aug 17 '20 12:08 ioquatix

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".

AlexWayfer avatar Nov 09 '20 21:11 AlexWayfer

Yes, understood.

ioquatix avatar Nov 09 '20 23:11 ioquatix

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.

ylecuyer avatar Feb 27 '21 18:02 ylecuyer

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.

luizkowalski avatar May 25 '21 14:05 luizkowalski

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

ioquatix avatar May 26 '21 05:05 ioquatix