Project

General

Profile

Wiki » History » Version 22

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