Skip to content
Newer
Older
100644 149 lines (85 sloc) 3.67 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
f3303f2 @nslater documentation improvements
nslater authored
11 * Erlang OTP (>=R12B5) (http://erlang.org/)
12 * ICU (http://icu.sourceforge.net/)
13 * OpenSSL (http://www.openssl.org/)
14 * Mozilla SpiderMonkey (1.8) (http://www.mozilla.org/js/spidermonkey/)
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
f3303f2 @nslater documentation improvements
nslater authored
24 The CouchDB build makes use of 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
53 If you do not do this, the ones found in `/usr/bin` may be used instead.
df02faf @nslater initial round of documentation changes
nslater authored
54
f3303f2 @nslater documentation improvements
nslater authored
55 Building Erlang
56 ---------------
df02faf @nslater initial round of documentation changes
nslater authored
57
f3303f2 @nslater documentation improvements
nslater authored
58 You must include OpenSSL.
df02faf @nslater initial round of documentation changes
nslater authored
59
f3303f2 @nslater documentation improvements
nslater authored
60 However, you can skip the GUI tools by running:
61
62 echo "skipping gs" > lib/gs/SKIP
63
64 echo "skipping ic" > lib/ic/SKIP
65
66 Follow the rest of the Erlang instructions as described.
67
68 After running:
69
70 ./otp_build release -a
71
72 You should run:
73
74 ./release/win32/Install.exe
df02faf @nslater initial round of documentation changes
nslater authored
75
f3303f2 @nslater documentation improvements
nslater authored
76 This will set up the release/win32/bin directory correctly.
df02faf @nslater initial round of documentation changes
nslater authored
77
f3303f2 @nslater documentation improvements
nslater authored
78 To set up your environment for building CouchDB, run:
df02faf @nslater initial round of documentation changes
nslater authored
79
f3303f2 @nslater documentation improvements
nslater authored
80 eval `./otp_build env_win32`
81
82 To set up the `ERL_TOP` environment variable, run:
83
84 export ERL_TOP=[ERL_TOP]
85
86 Replace `[ERL_TOP]` with the Erlang source directory name.
87
88 Remember to use `/cygdrive/c/` instead of `c:/` as the directory prefix.
89
90 To set up your path, run:
df02faf @nslater initial round of documentation changes
nslater authored
91
f3303f2 @nslater documentation improvements
nslater authored
92 export PATH=$ERL_TOP/release/win32/erts-5.7.2/bin:$PATH
df02faf @nslater initial round of documentation changes
nslater authored
93
f3303f2 @nslater documentation improvements
nslater authored
94 If everything was successful, you should be ready to build CouchDB.
df02faf @nslater initial round of documentation changes
nslater authored
95
96 Relax.
97
f3303f2 @nslater documentation improvements
nslater authored
98 Building CouchDB
99 ----------------
100
101 Once you have satisfied the dependencies you should run:
df02faf @nslater initial round of documentation changes
nslater authored
102
f3303f2 @nslater documentation improvements
nslater authored
103 ./configure \
104 --with-js-include=/cygdrive/c/path_to_seamonkey_include \
105 --with-js-lib=/cygdrive/c/path_to_seamonkey_lib \
106 --with-win32-icu-binaries=/cygdrive/c/path_to_icu_binaries_root \
107 --with-erlang=$ERL_TOP/release/win32/usr/include \
108 --with-win32-curl=/cygdrive/c/path/to/curl/root/directory \
109 --with-openssl-bin-dir=/cygdrive/c/openssl/bin \
110 --with-msvc-redist-dir=/cygdrive/c/dir/with/vcredist_platform_executable \
111 --prefix=$ERL_TOP/release/win32
df02faf @nslater initial round of documentation changes
nslater authored
112
f3303f2 @nslater documentation improvements
nslater authored
113 This command could take a while to complete.
df02faf @nslater initial round of documentation changes
nslater authored
114
f3303f2 @nslater documentation improvements
nslater authored
115 If everything was successful you should see the following message:
df02faf @nslater initial round of documentation changes
nslater authored
116
f3303f2 @nslater documentation improvements
nslater authored
117 You have configured Apache CouchDB, time to relax.
df02faf @nslater initial round of documentation changes
nslater authored
118
f3303f2 @nslater documentation improvements
nslater authored
119 Relax.
df02faf @nslater initial round of documentation changes
nslater authored
120
f3303f2 @nslater documentation improvements
nslater authored
121 To install CouchDB you should run:
df02faf @nslater initial round of documentation changes
nslater authored
122
f3303f2 @nslater documentation improvements
nslater authored
123 make install
df02faf @nslater initial round of documentation changes
nslater authored
124
f3303f2 @nslater documentation improvements
nslater authored
125 If everything was successful you should see the following message:
df02faf @nslater initial round of documentation changes
nslater authored
126
f3303f2 @nslater documentation improvements
nslater authored
127 You have installed Apache CouchDB, time to relax.
df02faf @nslater initial round of documentation changes
nslater authored
128
f3303f2 @nslater documentation improvements
nslater authored
129 Relax.
df02faf @nslater initial round of documentation changes
nslater authored
130
f3303f2 @nslater documentation improvements
nslater authored
131 First Run
132 ---------
df02faf @nslater initial round of documentation changes
nslater authored
133
f3303f2 @nslater documentation improvements
nslater authored
134 You can start the CouchDB server by running:
df02faf @nslater initial round of documentation changes
nslater authored
135
f3303f2 @nslater documentation improvements
nslater authored
136 $ERL_TOP/release/win32/bin/couchdb.bat
df02faf @nslater initial round of documentation changes
nslater authored
137
f3303f2 @nslater documentation improvements
nslater authored
138 When CouchDB starts it should eventually display the following message:
df02faf @nslater initial round of documentation changes
nslater authored
139
f3303f2 @nslater documentation improvements
nslater authored
140 Apache CouchDB has started, time to relax.
df02faf @nslater initial round of documentation changes
nslater authored
141
f3303f2 @nslater documentation improvements
nslater authored
142 Relax.
df02faf @nslater initial round of documentation changes
nslater authored
143
f3303f2 @nslater documentation improvements
nslater authored
144 To check that everything has worked, point your web browser to:
df02faf @nslater initial round of documentation changes
nslater authored
145
f3303f2 @nslater documentation improvements
nslater authored
146 http://127.0.0.1:5984/_utils/index.html
df02faf @nslater initial round of documentation changes
nslater authored
147
f3303f2 @nslater documentation improvements
nslater authored
148 From here you should run the test suite.
Something went wrong with that request. Please try again.