diff --git a/README.rst b/README.rst index e806f8b..b9b4fe2 100644 --- a/README.rst +++ b/README.rst @@ -48,12 +48,17 @@ Some use cases: * time-stamp log files at rotation time. * time-stamp file at upload to prove it was delivered in due time or not. -Quick Start ------------ +Quick (and dirty) Testing +------------------------- + +Here a few steps to quickly trying out uts-server, for production setup, please compile civetweb externally and create proper CA and certificates: .. sourcecode:: bash # Building with civetweb embedded (will recover civetweb from github). + # Note: the BUNDLE_CIVETWEB option is only here for fast testing purpose + # The recommended way to deploy uts-server in production is to build civetweb + # separatly and to link against it. $ cmake . -DBUNDLE_CIVETWEB=ON $ make diff --git a/docs/install.rst b/docs/install.rst index ee8df17..37a70f3 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -12,10 +12,10 @@ List of dependencies uts-server relies on to run: Build dependencies ------------------ -List of dependencies needed to build civetweb: +List of dependencies needed to build uts-server: -* cmake -* either gcc or clang +* `CMake `_ +* either `gcc `_ or `clang `_ Compilation =========== @@ -28,12 +28,14 @@ uts-server is compiled using cmake: $ cmake . $ make - # If civetweb is not present - # this will get the proper tag of civetweb from upstream and compile it + # If civetweb is not present. + # this will get the master branch of civetweb from upstream and compile it. + # Only for developpment/testing purposes $ cmake . -DBUNDLE_CIVETWEB=ON $ make # Compile with debug flags + # Only for developpment/testing purposes $ cmake . -DDEBUG=ON $ make @@ -43,3 +45,16 @@ uts-server is compiled using cmake: # add -DDL_LINK=ON and/or -DGCC_S_LINK=ON) $ cmake . -DSTATIC=ON # -DDL_LINK=ON -DGCC_S_LINK=ON $ make + +.. warning:: + + The BUNDLE_CIVETWEB exists only for developpment/testing purposes. + + Please compile civetweb externally for building a production binary. + + Using this option outside of developpment/testing is a bad idea for the + following reasons: + + * having an external download in a build process is a bad idea + * recovering the master branch ensures that the build may break randomly + * a build proccess should be reproductible which is not the case with this option