aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/sledjchisl/README68
1 files changed, 67 insertions, 1 deletions
diff --git a/src/sledjchisl/README b/src/sledjchisl/README
index 5d0a7b1..88b7952 100644
--- a/src/sledjchisl/README
+++ b/src/sledjchisl/README
@@ -2,7 +2,8 @@ I'm re-purposing this for SledjHamr https://sledjhamr.org/git/docs/index.html
2 2
3The general structure of SledjHamr is a bunch of servers talking to each 3The general structure of SledjHamr is a bunch of servers talking to each
4other via Internet (or just local) connections. One of them is a web 4other via Internet (or just local) connections. One of them is a web
5server for assets, world data, and inventory. 5server for assets, world data, and inventory. Actually most of OpenSim
6is just a collection of web servers.
6 7
7Originally I didn't think using a web based world client was a good idea, 8Originally I didn't think using a web based world client was a good idea,
8however it might be better to have one, for reasons. Now I need a web 9however it might be better to have one, for reasons. Now I need a web
@@ -49,3 +50,68 @@ FCGI has methods of dealing with auth and templates. B-)
49So for now I think I'll have the text and web management front ends in 50So for now I think I'll have the text and web management front ends in
50sledjchisl.c, and the love world server as well. I can split them up 51sledjchisl.c, and the love world server as well. I can split them up
51later if I need to. 52later if I need to.
53
54
55--------------------------------------------------------------------
56
57How to install it.
58------------------
59
60It's all still partly written, un-released, and experimental at the
61moment. So thes are just rough notes about what is needed.
62
63There are two parts, the OpenSim runner part and the web pages part. The
64OpenSim runner part requjires the rest of opensim-SC to be installed,
65which is covered by other documents in this source code repo. SO the
66below only talks about the web pages part.
67
68So far I have only tried this with Apache 2, but it should work fine with
69other web servers that support FCGI. I'm using spawn-fcgi which was
70written for lighttpd, and seems to be the proper way to support FCGI in
71Nginx as well.
72
73Until I have actually released this, it'll be source code only. So you
74need a C development environment to compile all the C source code.
75
76Some of the dependencies are included, like LuaJIT, qLibc, the FCGI SDK,
77and toybox. Or at least their source code git ropes are cloned during
78the build stage. The other dependencies are the development environments
79for MariaDB or MySQL (only tested with MariaDB), OpenSSL, and UUID. And
80spawn-fcgi. In a Debian based Linux distro, that could be installed by
81something like -
82
83apt install libmariadbclient-dev libssl1.0-dev uuid-dev spawn-fcgi
84
85Once you have all of that, you can run the src/BuildIt.sh script to put
86it all together. That script will also actually run the web side of
87things. Often during this early development process, that script will
88run things under a test tool like valgrind, so you'll probably need that
89to.
90
91You'll need to configure your web server to pass web requests onto
92sledjchisl. I'll add instructions for other popular web servers latel,
93but for now, this is what to do with Apache 2.
94
95Load the mod_proxy_fcgi module. Include something like this in your
96virtual host definition -
97
98<FilesMatch "\.fcgi$">
99 SetHandler "proxy:unix:///opt/opensim_SC/var/cache/sledjchisl.socket|fcgi://localhost/"
100</FilesMatch>
101
102Adjust that unix:// path to match if you have installed things elsewhere.
103
104Copy the files in example/www to where eveqer your web servers document
105root is.
106
107Note that the account.html dynamic web page redirects to a HTTPS version
108of itself, so you'll need HTTPS to be working.
109
110The current web pages will then be available at something like -
111
112http://localhost/sledjchisl.fcgi/loginpage.html
113
114http://localhost/sledjchisl.fcgi/stats.html
115
116https://localhost/sledjchisl.fcgi/account.html
117