Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

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