Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 154 lines (88 sloc) 3.967 kB
f3303f2 @nslater documentation improvements
nslater authored
1 Apache CouchDB README.Windows
2 ==============================
df02faf @nslater initial round of documentation changes
nslater authored
3
f3303f2 @nslater documentation improvements
nslater authored
4 For a high-level guide to Microsoft Windows.
df02faf @nslater initial round of documentation changes
nslater authored
5
f3303f2 @nslater documentation improvements
nslater authored
6 Dependencies
7 ------------
df02faf @nslater initial round of documentation changes
nslater authored
8
f3303f2 @nslater documentation improvements
nslater authored
9 You will need the following installed:
df02faf @nslater initial round of documentation changes
nslater authored
10
c573bf1 @davisp Improve Windows build docs.
davisp authored
11 * Erlang OTP (=14B01) (http://erlang.org/)
3e72b96 @tilgovi Bump Windows ICU requirement to v4.4.*
tilgovi authored
12 * ICU (=4.4.*) (http://icu.sourceforge.net/)
f3303f2 @nslater documentation improvements
nslater authored
13 * OpenSSL (http://www.openssl.org/)
b148b5b @tilgovi Minor doc and configure fixes for old JS engines
tilgovi authored
14 * Mozilla SpiderMonkey (1.7) (http://www.mozilla.org/js/spidermonkey/)
f3303f2 @nslater documentation improvements
nslater authored
15 * libcurl (http://curl.haxx.se/libcurl/)
16 * Cygwin (http://www.cygwin.com/)
17 * Visual Studio 2008 (http://msdn.microsoft.com/en-gb/vstudio/default.aspx)
df02faf @nslater initial round of documentation changes
nslater authored
18
f3303f2 @nslater documentation improvements
nslater authored
19 General Notes
20 -------------
df02faf @nslater initial round of documentation changes
nslater authored
21
f3303f2 @nslater documentation improvements
nslater authored
22 * When installing Erlang, you must build it from source.
df02faf @nslater initial round of documentation changes
nslater authored
23
3e72b96 @tilgovi Bump Windows ICU requirement to v4.4.*
tilgovi authored
24 The CouchDB build requires a number of the Erlang build scripts.
df02faf @nslater initial round of documentation changes
nslater authored
25
26 * When installing ICU, select the binaries built with Visual Studio 2008.
27
28 * When installing Cygwin, be sure to select all the `development` tools.
29
f3303f2 @nslater documentation improvements
nslater authored
30 * When installing libcurl, be sure to install by hand.
df02faf @nslater initial round of documentation changes
nslater authored
31
f3303f2 @nslater documentation improvements
nslater authored
32 The Cygwin binaries are incompatible and will not work with Erlang.
df02faf @nslater initial round of documentation changes
nslater authored
33
f3303f2 @nslater documentation improvements
nslater authored
34 Setting Up Cygwin
35 -----------------
36
37 Before starting any Cygwin terminals, run:
df02faf @nslater initial round of documentation changes
nslater authored
38
39 set CYGWIN=nontsec
40
f3303f2 @nslater documentation improvements
nslater authored
41 To set up your environment, run:
df02faf @nslater initial round of documentation changes
nslater authored
42
43 [VS_BIN]/vcvars32.bat
44
45 Replace [VS_BIN] with the path to your Visual Studio `bin` directory.
46
f3303f2 @nslater documentation improvements
nslater authored
47 You must check that:
df02faf @nslater initial round of documentation changes
nslater authored
48
f3303f2 @nslater documentation improvements
nslater authored
49 * The `which link` command points to the Microsoft linker.
df02faf @nslater initial round of documentation changes
nslater authored
50
f3303f2 @nslater documentation improvements
nslater authored
51 * The `which cl` command points to the Microsoft compiler.
52
c573bf1 @davisp Improve Windows build docs.
davisp authored
53 * The `which mc` command points to the Microsoft message compiler.
54
55 * The `which mt` command points to the Microsoft manifest tool.
56
57 If you do not do this, the build may fail due to Cygwin ones found in `/usr/bin`
58 being used instead.
df02faf @nslater initial round of documentation changes
nslater authored
59
f3303f2 @nslater documentation improvements
nslater authored
60 Building Erlang
61 ---------------
df02faf @nslater initial round of documentation changes
nslater authored
62
c573bf1 @davisp Improve Windows build docs.
davisp authored
63 You must include Win32 OpenSSL.
df02faf @nslater initial round of documentation changes
nslater authored
64
f3303f2 @nslater documentation improvements
nslater authored
65 However, you can skip the GUI tools by running:
66
67 echo "skipping gs" > lib/gs/SKIP
68
69 echo "skipping ic" > lib/ic/SKIP
70
71 Follow the rest of the Erlang instructions as described.
72
73 After running:
74
75 ./otp_build release -a
76
77 You should run:
78
79 ./release/win32/Install.exe
df02faf @nslater initial round of documentation changes
nslater authored
80
f3303f2 @nslater documentation improvements
nslater authored
81 This will set up the release/win32/bin directory correctly.
df02faf @nslater initial round of documentation changes
nslater authored
82
f3303f2 @nslater documentation improvements
nslater authored
83 To set up your environment for building CouchDB, run:
df02faf @nslater initial round of documentation changes
nslater authored
84
f3303f2 @nslater documentation improvements
nslater authored
85 eval `./otp_build env_win32`
86
87 To set up the `ERL_TOP` environment variable, run:
88
89 export ERL_TOP=[ERL_TOP]
90
91 Replace `[ERL_TOP]` with the Erlang source directory name.
92
93 Remember to use `/cygdrive/c/` instead of `c:/` as the directory prefix.
94
95 To set up your path, run:
df02faf @nslater initial round of documentation changes
nslater authored
96
c573bf1 @davisp Improve Windows build docs.
davisp authored
97 export PATH=$ERL_TOP/release/win32/erts-5.8.2/bin:$PATH
df02faf @nslater initial round of documentation changes
nslater authored
98
f3303f2 @nslater documentation improvements
nslater authored
99 If everything was successful, you should be ready to build CouchDB.
df02faf @nslater initial round of documentation changes
nslater authored
100
101 Relax.
102
f3303f2 @nslater documentation improvements
nslater authored
103 Building CouchDB
104 ----------------
105
106 Once you have satisfied the dependencies you should run:
df02faf @nslater initial round of documentation changes
nslater authored
107
f3303f2 @nslater documentation improvements
nslater authored
108 ./configure \
c573bf1 @davisp Improve Windows build docs.
davisp authored
109 --with-js-include=/cygdrive/c/path_to_spidermonkey_include \
110 --with-js-lib=/cygdrive/c/path_to_spidermonkey_lib \
f3303f2 @nslater documentation improvements
nslater authored
111 --with-win32-icu-binaries=/cygdrive/c/path_to_icu_binaries_root \
112 --with-erlang=$ERL_TOP/release/win32/usr/include \
113 --with-win32-curl=/cygdrive/c/path/to/curl/root/directory \
114 --with-openssl-bin-dir=/cygdrive/c/openssl/bin \
115 --with-msvc-redist-dir=/cygdrive/c/dir/with/vcredist_platform_executable \
116 --prefix=$ERL_TOP/release/win32
df02faf @nslater initial round of documentation changes
nslater authored
117
f3303f2 @nslater documentation improvements
nslater authored
118 This command could take a while to complete.
df02faf @nslater initial round of documentation changes
nslater authored
119
f3303f2 @nslater documentation improvements
nslater authored
120 If everything was successful you should see the following message:
df02faf @nslater initial round of documentation changes
nslater authored
121
f3303f2 @nslater documentation improvements
nslater authored
122 You have configured Apache CouchDB, time to relax.
df02faf @nslater initial round of documentation changes
nslater authored
123
f3303f2 @nslater documentation improvements
nslater authored
124 Relax.
df02faf @nslater initial round of documentation changes
nslater authored
125
f3303f2 @nslater documentation improvements
nslater authored
126 To install CouchDB you should run:
df02faf @nslater initial round of documentation changes
nslater authored
127
f3303f2 @nslater documentation improvements
nslater authored
128 make install
df02faf @nslater initial round of documentation changes
nslater authored
129
f3303f2 @nslater documentation improvements
nslater authored
130 If everything was successful you should see the following message:
df02faf @nslater initial round of documentation changes
nslater authored
131
f3303f2 @nslater documentation improvements
nslater authored
132 You have installed Apache CouchDB, time to relax.
df02faf @nslater initial round of documentation changes
nslater authored
133
f3303f2 @nslater documentation improvements
nslater authored
134 Relax.
df02faf @nslater initial round of documentation changes
nslater authored
135
f3303f2 @nslater documentation improvements
nslater authored
136 First Run
137 ---------
df02faf @nslater initial round of documentation changes
nslater authored
138
f3303f2 @nslater documentation improvements
nslater authored
139 You can start the CouchDB server by running:
df02faf @nslater initial round of documentation changes
nslater authored
140
f3303f2 @nslater documentation improvements
nslater authored
141 $ERL_TOP/release/win32/bin/couchdb.bat
df02faf @nslater initial round of documentation changes
nslater authored
142
f3303f2 @nslater documentation improvements
nslater authored
143 When CouchDB starts it should eventually display the following message:
df02faf @nslater initial round of documentation changes
nslater authored
144
f3303f2 @nslater documentation improvements
nslater authored
145 Apache CouchDB has started, time to relax.
df02faf @nslater initial round of documentation changes
nslater authored
146
f3303f2 @nslater documentation improvements
nslater authored
147 Relax.
df02faf @nslater initial round of documentation changes
nslater authored
148
f3303f2 @nslater documentation improvements
nslater authored
149 To check that everything has worked, point your web browser to:
df02faf @nslater initial round of documentation changes
nslater authored
150
f3303f2 @nslater documentation improvements
nslater authored
151 http://127.0.0.1:5984/_utils/index.html
df02faf @nslater initial round of documentation changes
nslater authored
152
c573bf1 @davisp Improve Windows build docs.
davisp authored
153 From here you should run the test suite in either Firefox 3.6+ or Safari 4+.
Something went wrong with that request. Please try again.