Project

General

Profile

Wiki » History » Version 23

Tomek Dziemidowicz, 2019-07-04 08:38 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 2 Tomek Dziemidowicz
h2. Conflict Resolution
59
60
h2. Update procedure
61
62
h2. Data filtering
63
64 1 Tomek Dziemidowicz
h2. Installation
65 9 Tomek Dziemidowicz
66 18 Tomek Dziemidowicz
h3. Server Prerequisites
67
68
To make ampli-sync server work you need:
69
* Apache Tomcat 8.
70
* Java
71
* Linux/Windows environment. 
72
73 9 Tomek Dziemidowicz
h3. Manual
74
75 14 Tomek Dziemidowicz
Steps needed to install AMPLI-SYNC manually on Ubuntu.
76
77 15 Tomek Dziemidowicz
# Install Tomcat on Ubuntu:
78 14 Tomek Dziemidowicz
https://www.digitalocean.com/community/tutorials/how-to-install-apache-tomcat-8-on-ubuntu-16-04
79
# Create new user
80
<pre>
81
sudo adduser amplisync
82
</pre>
83
System will ask you for password for newly created user.
84
# Add user to group ‘tomcat’
85
<pre>
86
sudo usermod -a -G tomcat amplisync
87
</pre>
88
# Chang in web.xml path variable to 
89
<pre>
90
\home/sqlitesync/demo
91
</pre>
92
# Install new application in Tomcat. Start with switching to amplisync user.
93
<pre>
94
su amplisync
95
</pre>
96
# Create new folder /home/sqlitesync/demo
97 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.
98 17 Tomek Dziemidowicz
# Restart Tomcat:
99 14 Tomek Dziemidowicz
<pre>
100
service tomcat restart
101
</pre>
102
Now you can access your installation using link:
103
<pre>
104
http://your_ip:8080/amplisync-app-name/API3
105
</pre>
106
# Setup permissions:
107
<pre>
108
chown -R sqlitesync:tomcat /home/amplisync/demo/
109
</pre>
110
111 9 Tomek Dziemidowicz
h3. Docker
112 2 Tomek Dziemidowicz
113 20 Tomek Dziemidowicz
h3. Configuring AMPLI-SYNC service
114 19 Tomek Dziemidowicz
115
First you need to adjust website configuration file (web.xml), then you need to change main configuration file (sync.properties).
116
*Service configuration (web.xml)*
117
Go to your_webapps_folder/SqliteSync/WEB-INF/web.xml and open for edit. Navigate to section:
118
<pre><code class="xml">
119
<env-entry>
120
<env-entry-name>working-dir</env-entry-name>
121
<env-entry-type>java.lang.String</env-entry-type>
122
<env-entry-value>/your/working/dir/sqlite-sync/</env-entry-value>
123
</env-entry>
124
</code></pre>
125
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:
126
<pre>
127
\working_dir\config\sync.properties
128
</pre>
129
*IMPORTANT* Restart service after changing web.xml. Make sure that Tomcat has read/write access to working dir.
130
Sample configurations for MySQL server
131
<pre>
132
DB_ENGINE = mysql
133
DBURL = jdbc:mysql://server:3306/dbname?rewriteBatchedStatements=true
134
DBUSER = user
135
DBPASS = pass
136
DBDRIVER = com.mysql.cj.jdbc.Driver
137
DATE_FORMAT = yyyy-MM-dd HH:mm:ss
138
HISTORY_DAYS = 7
139
LOG_LEVEL = 4
140
</pre>
141
If you faced a timezone error after configuration in `sync.properties` add at the end of connection string:
142
<pre>
143
&useUnicode=true&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC
144
</pre>
145
*Keys explanation*
146 21 Tomek Dziemidowicz
*DB_ENGINE* - type of database engine. Available options:
147
* mysql
148
* mssql
149
* postgresql
150
* oracle
151
152 19 Tomek Dziemidowicz
*LOG_LEVEL* - defain details level for log
153
> 4: TRACE, DEBUG, INFO, WARN; (default)
154
> 3: DEBUG, INFO, WARN; 
155
> 2: INFO,WARN; 
156
> 1: WARN; 
157
> 0 - disable logs
158
*DATE_FORMAT* - set format of date 
159
default format: yyyy-MM-dd HH:mm:ss 
160
*HISTORY_DAYS* - How long files with sync data will be kept
161
default value: 7
162
When you use MySQL database DO NOT remove from the end of the connection string:
163
<pre>
164
?rewriteBatchedStatements=true
165 20 Tomek Dziemidowicz
</pre>
166 19 Tomek Dziemidowicz
167 2 Tomek Dziemidowicz
h2. Supported databases
168
169
h2. Samples