forked from FellowTraveler/Open-Transactions-old
-
Notifications
You must be signed in to change notification settings - Fork 0
/
GETTING-STARTED.txt
207 lines (122 loc) · 5.24 KB
/
GETTING-STARTED.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
Welcome to Open Transactions.
See LICENSE-AND-CREDITS file, which should be in the same
folder as this README file. You agree to the terms.
Online install instructions:
https://github.com/FellowTraveler/Open-Transactions/wiki/Install
-------------------------------------------------------------------------
GETTING STARTED:
1) For most, assuming you have all the necessary libraries installed already,
(OpenSSL 1.0.0, MsgPack, Protocol Buffers, and ZeroMQ) then you just type
this to build:
make
(It will auto-detect platform, etc.)
Then: sudo make install
If you also want the Java version (for the Moneychanger GUI) then do
this next:
make clean && make java
2) To run the server, type:
ot_server
(It will give you instructions.)
3) To run the test client, type:
ot -?
(It will give you instructions.)
** PASSWORD ** is test (always)
4) To run the Moneychanger client, just make sure the libotapi.jnilib aka
libotapi.so is in the same folder as the Moneychanger jar file and lib folder,
then double-click the jar file.
It will want to know where the data folder is: ~/.ot/client_data
-------------------------------------------------------------------------
IN MORE DETAIL:
INSTALL-Mac-Linux-FreeBSD.txt
(or) INSTALL-Windows.txt
(or) INSTALL-Android.txt
-------------------------------------------------------------------
Open Transactions requires OpenSSL version 1.0.0.
* To check current version: openssl version
* To upgrade on Mac: sudo port install openssl
If that doesn't work: sudo port install openssl-devel
* On Linux:
NOTE for 64-bit Linux: MAKE SURE you configure OpenSSL explicitly for 64-bit and for shared binaries, THEN re-build it. (OpenSSL does not come built with those options by default, on 64bit Linux.)
Again: For 64-bit Linux, run: "./configure -m64 shared" in the openssl folder BEFORE building OpenSSL 1.0.0, and then it should work when you build and run Open-Transactions.)
wget http://www.openssl.org/source/openssl-1.0.0d.tar.gz
tar -xf openssl-1.0.0d.tar.gz
cd openssl-1.0.0d
./config
make
sudo make install
* On FreeBSD (as root):
cd /usr/ports/security/openssl/ && make install clean
---------------------------------------------------------------
INSTALL: MsgPack Library (data packing library now used by OT.)
Available here: msgpack.org
To install from command line: port install msgpack
(OR) brew install msgpack
Install instructions for all platforms:
http://wiki.msgpack.org/display/MSGPACK/QuickStart+for+C+Language
---------------------------------------------------------------
INSTALL: Google's Protocol Buffers library (another data packer.)
Available here:
http://code.google.com/p/protobuf/downloads/list
---------------------------------------------------------------
INSTALL: ZeroMQ (transport library)
Available here:
http://www.zeromq.org/intro:get-the-software
port install zmq
---------------------------------------------------------------
DOWNLOAD OPEN TRANSACTIONS
git clone git://github.com/FellowTraveler/Open-Transactions.git
Source code (FYI):
https://github.com/FellowTraveler/Open-Transactions
----------------------------------------------------------------
BUILD OPEN TRANSACTIONS
cd Open-Transactions && make clean && make
FOR JAVA MODE (If using Moneychanger Java GUI):
make clean && make java
---------------------------------------------------------------
BUILD THE API
To build the API for a specific language, try:
make java
make python
make php5
make perl5
make ruby
make c
make d
Etc. Use "make clean" between builds.
See testwallet/API-README.txt for full instructions on building
the API for the various different languages. (There are more languages
available.)
---------------------------------------------------------------
DEVELOPER RESOURCES
The OT API, with notes:
https://github.com/FellowTraveler/Open-Transactions/wiki/API
Use cases for the OT API:
https://github.com/FellowTraveler/Open-Transactions/wiki/Use-Cases
---------------------------------------------------------------
TO START THE SERVER
cd transaction && ./transaction.exe
OR: ot_server will work from any folder, if you did make install.
The server requires a password and a path when it starts up.
(It will tell you what to do.)
FYI, the data folder for the server is:
~/.ot/server_data
If you want to back up a copy of it, then you can feel free
to play around with the data files, knowing you can refresh them
at any time.
---------------------------------------------------------------
TO RUN THE TEST CLIENT
Once the server is running, then try the testwallet in a
separate terminal:
cd Open-Transactions && cd testwallet && ./testwallet.exe
OR: ot will work from any folder, if you did make install.
Again, it will ask you to enter a password and a path.
Don't worry, it gives clear instructions.
To use the testwallet, read ~/.ot/CLIENT-COMMANDS.txt
Online:
https://github.com/FellowTraveler/Open-Transactions/wiki/Test-Wallet-commands
Note: the test wallet and the API are really just different build
options for the same client-side code, which is located in the
Open-Transactions/testwallet folder.
The data folder for the client is:
~/.ot/client_data
Fresh copies of all data is located in Open-Transactions/ot-sample-data