github.com/lhzd863/cherry@v0.0.0-20200403104631-8e2d1d8f2d8a/README.md (about) 1 # Cherry [![Go Report Card](https://goreportcard.com/badge/github.com/rafael-santiago/cherry)](https://goreportcard.com/report/github.com/rafael-santiago/cherry) 2 3 ``Cherry`` is a ``webchat engine`` wrote in [``Golang``](https://github.com/golang/go). It brings the main functionalities that you need in a webchat server. 4 5 With this application you are able to serve a bunch of rooms from your machine just editing a configuration file in a specific language. 6 So if you are interested you should read the [documentation](https://github.com/rafael-santiago/cherry/blob/master/doc/README.md) to learn how to master it. 7 8 Now ``SSL connections`` are supported. 9 10 ## How to build it? 11 12 You can use the standard ``go build`` or you can use [Hefesto](https://github.com/rafael-santiago/hefesto). 13 14 ### Using go build 15 16 You need to setup your ``GOPATH`` to the project root. Supposing that cherry repo was cloned under ``/home/doctor/web/git-hub/rafael-santiago/cherry`` 17 just add this path to your ``GOPATH``. 18 19 Run ``go build`` from inside the ``src`` subdirectory. 20 21 ### Using hefesto 22 23 After following all steps to put Hefesto to work on your system just move to ``src`` subdirectory and invoke ``Hefesto`` from 24 inside. Something like: 25 26 ``` 27 doctor@TARDIS:~/web/git-hub/rafael-santiago/cherry/src# hefesto 28 ``` 29 30 If all worked a cherry binary was created under ``../bin/`` and 31 32 All done. 33 34 Here you do not need to worry about ``GOPATH`` issues because Hefesto's script handles it for you on each build task that you invoke (if needed). 35 36 ## How to run it? 37 38 This application works based on a configuration file (again: [documentation](https://github.com/rafael-santiago/cherry/blob/master/doc/README.md)). 39 40 You specify this configuration using the option ``--config``: 41 42 ``` 43 doctor@TARDIS:~/web/git-hub/rafael-santiago/cherry/bin# ./cherry --config=gallifrey-lounge.cherry 44 45 ``` 46 47 Supposing that ``TARDIS`` has the ``IP`` address ``192.30.70.3`` and ``Gallifrey lounge`` opens only one room at the port 1008. 48 Doctor should access the entrace form served at: 49 50 ``` 51 http://192.30.70.3:1008/join 52 ``` 53 54 That's all.