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