naviserver / naviserver (http://naviserver.sf.net/)

fork of aolserver-40x

NaviServer is a high performance web server written in C and Tcl. It can be easily extended in either language to create interesting web sites and services.

Clone this repository (size: 9.7 MB): HTTPS / SSH
$ hg clone http://bitbucket.org/naviserver/naviserver/
commit 2170: 131a9f67c01b
parent 2169: 37c7bfb09160
branch: default
Update the README with new location of source code etc.
Stephen Deasey / groks
14 months ago

Changed (Δ1.6 KB):

raw changeset »

README (135 lines added, 83 lines removed)

Up to file-list README:

@@ -19,14 +19,18 @@ 1. Introduction
19
19
---------------
20
20
21
21
NaviServer is maintained, enhanced, and distributed freely by the
22
open source community.  The home for NaviServer sources and bug/patch
23
database is located on SourceForge site:
22
open source community.  The home for NaviServer downloads and bug/patch
23
database is located on the SourceForge site:
24
24
25
   http://sourceforge.net/projects/naviserver
25
    http://sourceforge.net/projects/naviserver
26
26
27
Another resource is the NaviServer wiki:
27
Source code is available from the BitBucket site:
28
28
29
   http://naviserver.sourceforge.net
29
    http://bitbucket.org/naviserver/
30
31
Another resource is the Tcl wiki:
32
33
    http://wiki.tcl.tck/naviserver
30
34
31
35
NaviServer is a freely available open source package.  See the file
32
36
"license.terms" for complete information.
@@ -35,11 +39,15 @@ NaviServer is a freely available open so
35
39
2. Documentation
36
40
----------------
37
41
38
Documentation will be available in the "doc" subdirectory. At this
39
point the documentation is incomplete and is considered to be the
40
work in progress. Once done, it will be distributed in Unix nroff
41
format (suitable for viewing with Unix "man" command) and HTML 
42
format (suitable for viewing with any HTML-compatible browser).
42
Documentation is available in the "doc" subdirectory. At this
43
point it is incomplete and is considered to be a work in progress.
44
Once done, it will be distributed in Unix nroff format (suitable
45
for viewing with Unix "man" command) and HTML format (suitable
46
for viewing with any HTML-compatible browser).
47
48
The latest development version is available online:
49
50
    http://naviserver.sourceforge.net/n/toc.html
43
51
44
52
45
53
3. Compiling and installing
@@ -48,52 +56,75 @@ 3. Compiling and installing
48
56
The server is known to compile and run on FreeBSD, Linux, Solaris, 
49
57
Mac OS/X 10.2+ and Windows. To compile and install:
50
58
51
3a.     Download, configure, build and install Tcl 8.4 or better
52
	with threads and shared libraries enabled.  To do so,
53
	download the latest release from http://tcl.tk and following
54
	the instructions in the included README.  You may install
55
	Tcl within the directory you intend to install the server 
56
	(e.g., /usr/local/ns) or in some other location.
57
	The following should work:
58
59
59
	% gunzip < tcl8.4.12-src.tar.gz | tar xvf -
60
	% cd tcl8.4.12/unix
61
	% ./configure --prefix=/usr/local/ns --enable-threads
62
	% make install
63
	
64
3b.     If you don't have GNU make (Linux make is GNU make), install
65
	it as server's makefiles require it.  If you're not sure
66
	if you have GNU make, try "make -v" to check.  You can get
67
	GNU make at http://www.gnu.org.
60
3a. Download, configure, build and install Tcl 8.4 or better
68
61
69
3c.     Download, configure, build, and install.
70
	The following should work:
62
    You may use the version of Tcl already installed on your machine
63
    if it was built with threads enabled. The configure step below
64
    will complain if this is not the case.
71
65
72
	% gunzip < naviserver-4.99.1.tar.gz | tar xvf -
73
	% cd naviserver-4.99.1
74
	% ./configure --prefix=/usr/local/ns --with-tcl=/usr/local/ns/lib
75
	% make install
66
    You can download the latest Tcl release from http://tcl.tk and follow
67
    the instructions in the included README. You may install Tcl within the
68
    directory you intend to install the server (e.g., /usr/local/ns) or
69
    in some other location. The following should work:
76
70
77
	The server's configure script takes the following options:
71
    $ gunzip < tcl8.4.12-src.tar.gz | tar xvf -
72
    $ cd tcl8.4.12/unix
73
    $ ./configure --prefix=/usr/local/ns --enable-threads --enable-symbols
74
    $ make install
78
75
79
	--with-tcl=/usr/local/ns/lib
80
76
81
		Path to library installation directory of Tcl where
82
		configure can find the tclConfig.sh script.  Without
83
		this option, configure will search around for
84
		tclConfig.sh, perhaps finding it in ../tcl8.4.12/unix.
77
3b. If you don't have GNU make (Linux make is GNU make), install
78
    it, as the server's makefiles require it.  If you're not sure
79
    if you have GNU make, try "make -v" to check.  You can get
80
    GNU make at http://www.gnu.org.
85
81
86
	--enable-symbols
87
82
88
		Compile with debug symbols enabled.  The default
89
		is to compile optimized.
83
3c. Download, configure, build, and install NaviServer.
90
84
91
	--prefix=/usr/local/ns
85
    Oficial releases:
92
86
93
		Set the installation directory for the server.  All
94
		program, man page, and runtime files (e.g., log
95
		files) will be install or updated within this
96
		directory.
87
        http://sourceforge.net/project/showfiles.php?group_id=130646
88
89
    Latest development source code:
90
91
        http://bitbucket.org/naviserver/naviserver/
92
93
    The following should work for official releases:
94
95
        $ gunzip < naviserver-4.99.2.tar.gz | tar xvf -
96
        $ cd naviserver-4.99.2
97
        $ ./configure --prefix=/usr/local/ns --with-tcl=/usr/local/ns/lib --enable-symbols
98
        $ make
99
        $ su -c 'make install'
100
101
    The server's configure script takes the following options:
102
103
    --with-tcl=/usr/local/ns/lib
104
105
        Path to library installation directory of Tcl where
106
        configure can find the tclConfig.sh script.  Without
107
        this option, configure will search around for
108
        tclConfig.sh, perhaps finding it in ../tcl8.4.12/unix.
109
110
    --with-zlib=/usr
111
112
        You will need the zlib compression library headers available.
113
        e.g. $ yum install zlib-devel, for Fedora Linux. If the headers
114
        are not located in the usual places where the compiler looks,
115
        you can tell configure where to find them with the --with-zlib
116
        option.
117
118
    --enable-symbols
119
120
        Compile with debug symbols enabled. Recommended.
121
122
    --prefix=/usr/local/ns
123
124
        Set the installation directory for the server.  All
125
        program, man page, and runtime files (e.g., log
126
        files) will be install or updated within this
127
        directory.
97
128
98
129
99
130
        To compile with Purify tool, set the variable $PURIFY to 
@@ -102,60 +133,81 @@ 3c. Download, configure, build, and
102
133
        make PURIFY="purify -cache-dir=/home/joe/my-cache-dir" install
103
134
104
135
105
        If you checked out the source directly from CVS on SourceForge
106
        replace "./configure" in the example above with "./autogen.sh"
107
        to get initial makefiles created.
136
    If you checked out the source directly replace "./configure"
137
    in the example above with "./autogen.sh" to get the initial
138
    makefiles created.
108
139
109
3d.     Create and edit a config file, nsd.tcl by convention.
110
	A sample is provided to get started:
140
    You will need recent versions of autoconf and automake installed.
141
    You will need 'dtplite' which is part of 'tcllib' installed if you
142
    want to build the documentation.
111
143
112
	% cd /usr/local/ns
113
	% cp sample-config.tcl nsd.tcl
114
	% vi nsd.tcl
115
144
145
3d. Create and edit a config file (nsd.tcl, by convention)
116
146
117
3e.	Try running the server in a shell window:
147
    A couple of samples are provided to get you started:
118
148
119
	% cd /usr/local/ns
120
	% bin/nsd -f -t conf/nsd.tcl
149
    $ cd /usr/local/ns
150
    $ cp sample-config.tcl nsd.tcl
151
    $ vi nsd.tcl
121
152
122
3f.	To download and install additional modules:
153
    sample-config.tcl contains every possible configuration option and
154
    it's default value. Remove the ones you don't need.
123
155
124
	% cvs -d:pserver:anonymous@naviserver.cvs.sourceforge.net:/cvsroot/naviserver login
125
 	% cvs -z3 -d:pserver:anonymous@naviserver.cvs.sourceforge.net:/cvsroot/naviserver co -P modules
126
	% cd modules
127
	% make install
156
    simple-config.tcl contains a basic set of the important configuration
157
    options you are likely to need. Add to it as neccessary. 
128
158
129
	Not all modules will be compiled by default due to external dependencies, so
130
	please look into module's README file for any additional information.
131
159
132
3g.	To compiling for Windows you need Msys + Mingw [http://www.mingw.org/download.shtml]
160
3e. Try running the server in a shell window:
133
161
134
        http://prdownloads.sourceforge.net/tcl/msys_mingw8.zip
162
    $ cd /usr/local/ns
163
    $ ./bin/nsd -f -t conf/nsd.tcl
135
164
136
        This Msys + Mingw download above is the minimal environment needed
137
        to build Naviserver under Windows. It includes a shell environment and
138
        gcc. To install, you just download the zip file and extract the
139
        files into a directory. The README.TXT file describes how to launch
140
        the msys shell, you then run the configure script in the naviserver
141
        directory. The Msys based configure/build process works just like the 
142
	UNIX one. 
165
    The '-f' option runs the server in the foreground with important
166
    log messages directed to your terminal.
143
167
144
	Example of building naviserver.exe:
145
168
146
	Run dos prompt or cmd.exe, assuming msys_mingw8.zip is unpacked in the root of drive c:
169
3f. To download and install additional modules:
147
170
148
	c:>cd msys
149
	c:\msys> msys.bat
171
    You will need the Mercurial version control system installed. It is
172
    included in most Linux distributions: e.g. yum install mercurial. For
173
    Windows and Mac OSX see: http://www.selenic.com/mercurial
150
174
151
	$ cd /c/naviserver-4.99.2-src
152
	$ ./configure --prefix=c:/naviserver --with-tcl=c:/naviserver/lib
153
	$ make install
175
        $ hg clone http://bitbucket.org/naviserver/nsfoo/
176
        $ cd nsfoo
177
        $ make install NAVISERVER=/usr/local/ns
154
178
179
    See: http://bitbucket.org/naviserver/ for a full list of modules.
155
180
156
	Example above assumes Tcl is built using mingw with prefix c:/naviserver
157
181
158
	
182
3g. To compile for Windows, you need Msys + Mingw
183
184
    Info:     http://www.mingw.org/download.shtml
185
    Download: http://prdownloads.sourceforge.net/tcl/msys_mingw8.zip
186
187
    The Msys + Mingw download above is the minimal environment needed
188
    to build Naviserver under Windows. It includes a shell environment and
189
    gcc.
190
191
    To install, you just download the zip file and extract the
192
    files into a directory. The README.TXT file describes how to launch
193
    the msys shell.
194
195
    You then run the configure script in the naviserver directory. The
196
    Msys based configure/build process works just like the UNIX one. 
197
198
    Example of building naviserver.exe:
199
200
    Run dos prompt or cmd.exe, assuming msys_mingw8.zip is unpacked in the root of drive c:
201
202
        c:>cd msys
203
        c:\msys> msys.bat
204
205
        $ cd /c/naviserver-4.99.2
206
        $ ./configure --prefix=c:/naviserver --with-tcl=c:/naviserver/lib
207
        $ make install
208
209
    Example above assumes Tcl is also built using mingw with prefix c:/naviserver
210
159
211
160
212
4. Mailing lists
161
213
----------------
@@ -163,7 +215,7 @@ 4. Mailing lists
163
215
There are mailing lists for NaviServer to discuss anything from
164
216
configuration, development, and future direction. To join visit:
165
217
166
  http://sourceforge.net/projects/naviserver
218
    http://sourceforge.net/projects/naviserver
167
219
168
220
Thank you for your interest in NaviServer.  We hope you find it
169
221
useful and look forward to hearing from you on our mailing list.