Project

General

Profile

Wiki » History » Version 24

Tomek Dziemidowicz, 2019-07-04 08:40 PM

1 2 Tomek Dziemidowicz
h1. SQLite-sync documentation
2
3
*Owner* : AMPLIFIER sp. z o.o.
4
*Contact* : support (at) ampliapps.com
5
*website* : https://ampliapps.com
6
7 3 Tomek Dziemidowicz
{{>toc}}
8
9 9 Tomek Dziemidowicz
Welcome to the AMPLI-SYNC documentation!
10
We have language bindings in JavaScript, .NET C#, Java and Objective-C! 
11 1 Tomek Dziemidowicz
12 9 Tomek Dziemidowicz
h2. AMPLI-SYNC concept
13
14
h3. Solution diagram
15
16 8 Tomek Dziemidowicz
!{width:700px}SQLite-sync-structure.png!
17 1 Tomek Dziemidowicz
18 13 Tomek Dziemidowicz
* Devices communicate with server using HTTP/HTTPS protocol. 
19
* Proxy Load Balancer. If necessary, proxy can redirect request to another instance of SQLite-core.
20
* Authorization provider will generate token based on response from authorization provider.
21 9 Tomek Dziemidowicz
22
h3. Proxy Balancer flowchart
23
24
!{width:400px}SQLite-sync-proxy-balancer.png!
25
26
h3. Authorization Provider flowchart
27
28
!{width:350px}SQLite-sync-authentication-process.png!
29
30 2 Tomek Dziemidowicz
h2. REST API (server API)
31
32 10 Tomek Dziemidowicz
h3. Protocol version
33
34
This document describes integration with the REST API 3.x protocol.
35
36
h3. Service description
37
38
There are two stages to processing a request:
39
40 12 Tomek Dziemidowicz
* Device places an request.
41
* SQLite-sync server confirms the request has been processed successfully and sends confirmation with eventual conflict list that need to be resolved.
42 10 Tomek Dziemidowicz
43 11 Tomek Dziemidowicz
h3. Synchronization flowchart
44
45
!{width:200px;}Device-synchronization-diagram.png!
46 10 Tomek Dziemidowicz
47 23 Tomek Dziemidowicz
h3. Request URL format
48 22 Tomek Dziemidowicz
49
Sample REST API call:
50
<pre>
51
https://example.com/API3/__method___
52
</pre>
53
Explanation:
54
*https://example.com/* - adres of REST API service 
55
*API3* - version of synchronization
56
*__method___* - method/action
57
58 24 Tomek Dziemidowicz
h3. API methods
59
60 2 Tomek Dziemidowicz
h2. Conflict Resolution
61
62
h2. Update procedure
63
64
h2. Data filtering
65
66 1 Tomek Dziemidowicz
h2. Installation
67 9 Tomek Dziemidowicz
68 18 Tomek Dziemidowicz
h3. Server Prerequisites
69
70
To make ampli-sync server work you need:
71
* Apache Tomcat 8.
72
* Java
73
* Linux/Windows environment. 
74
75 9 Tomek Dziemidowicz
h3. Manual
76
77 14 Tomek Dziemidowicz
Steps needed to install AMPLI-SYNC manually on Ubuntu.
78
79 15 Tomek Dziemidowicz
# Install Tomcat on Ubuntu:
80 14 Tomek Dziemidowicz
https://www.digitalocean.com/community/tutorials/how-to-install-apache-tomcat-8-on-ubuntu-16-04
81
# Create new user
82
<pre>
83
sudo adduser amplisync
84
</pre>
85
System will ask you for password for newly created user.
86
# Add user to group ‘tomcat’
87
<pre>
88
sudo usermod -a -G tomcat amplisync
89
</pre>
90
# Chang in web.xml path variable to 
91
<pre>
92
\home/sqlitesync/demo
93
</pre>
94
# Install new application in Tomcat. Start with switching to amplisync user.
95
<pre>
96
su amplisync
97
</pre>
98
# Create new folder /home/sqlitesync/demo
99 16 Tomek Dziemidowicz
# Upload new service amplisync-demo to Tomcat. You can do that using Tomcat application manager, or you can put WAR file in Tomcat webapps folder. Name of your WAR file is app name in Tomcat environment. Remember to not place spaces and special chars in name of your WAR file.
100 17 Tomek Dziemidowicz
# Restart Tomcat:
101 14 Tomek Dziemidowicz
<pre>
102
service tomcat restart
103
</pre>
104
Now you can access your installation using link:
105
<pre>
106
http://your_ip:8080/amplisync-app-name/API3
107
</pre>
108
# Setup permissions:
109
<pre>
110
chown -R sqlitesync:tomcat /home/amplisync/demo/
111
</pre>
112
113 9 Tomek Dziemidowicz
h3. Docker
114 2 Tomek Dziemidowicz
115 20 Tomek Dziemidowicz
h3. Configuring AMPLI-SYNC service
116 19 Tomek Dziemidowicz
117
First you need to adjust website configuration file (web.xml), then you need to change main configuration file (sync.properties).
118
*Service configuration (web.xml)*
119
Go to your_webapps_folder/SqliteSync/WEB-INF/web.xml and open for edit. Navigate to section:
120
<pre><code class="xml">
121
<env-entry>
122
<env-entry-name>working-dir</env-entry-name>
123
<env-entry-type>java.lang.String</env-entry-type>
124
<env-entry-value>/your/working/dir/sqlite-sync/</env-entry-value>
125
</env-entry>
126
</code></pre>
127
change env-entry-value key and point to working dir where SQLite-sync.com server will store log files, temporary files and configuration. Create manually a subfolder named config. Create a text file sync.properties in folder config. The path should look like this:
128
<pre>
129
\working_dir\config\sync.properties
130
</pre>
131
*IMPORTANT* Restart service after changing web.xml. Make sure that Tomcat has read/write access to working dir.
132
Sample configurations for MySQL server
133
<pre>
134
DB_ENGINE = mysql
135
DBURL = jdbc:mysql://server:3306/dbname?rewriteBatchedStatements=true
136
DBUSER = user
137
DBPASS = pass
138
DBDRIVER = com.mysql.cj.jdbc.Driver
139
DATE_FORMAT = yyyy-MM-dd HH:mm:ss
140
HISTORY_DAYS = 7
141
LOG_LEVEL = 4
142
</pre>
143
If you faced a timezone error after configuration in `sync.properties` add at the end of connection string:
144
<pre>
145
&useUnicode=true&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC
146
</pre>
147
*Keys explanation*
148 21 Tomek Dziemidowicz
*DB_ENGINE* - type of database engine. Available options:
149
* mysql
150
* mssql
151
* postgresql
152
* oracle
153
154 19 Tomek Dziemidowicz
*LOG_LEVEL* - defain details level for log
155
> 4: TRACE, DEBUG, INFO, WARN; (default)
156
> 3: DEBUG, INFO, WARN; 
157
> 2: INFO,WARN; 
158
> 1: WARN; 
159
> 0 - disable logs
160
*DATE_FORMAT* - set format of date 
161
default format: yyyy-MM-dd HH:mm:ss 
162
*HISTORY_DAYS* - How long files with sync data will be kept
163
default value: 7
164
When you use MySQL database DO NOT remove from the end of the connection string:
165
<pre>
166
?rewriteBatchedStatements=true
167 20 Tomek Dziemidowicz
</pre>
168 19 Tomek Dziemidowicz
169 2 Tomek Dziemidowicz
h2. Supported databases
170
171
h2. Samples