Changes for page FileSync

Last modified by Jan Brinkhaus on 2023/02/03 13:33
<
From version < 2.1 >
edited by Jan Brinkhaus
on 2023/02/02 17:26
To version < 8.1 >
edited by Jan Brinkhaus
on 2023/02/03 12:12
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,24 +1,84 @@
1 -Download token valid till ...
1 += Prerequisite: Docker installation =
2 2  
3 +FileSync is deployed as docker container. You need a running docker installation for it to be installed. if you setup a new VM for this, we suggest the newest Ubuntu LTS release.
3 3  
4 -sudo mkdir /var/docker_data
5 +If you already have a server or VM with a running docker, just skip this chapter and go on with "Installation".
5 5  
6 -cd /var/docker_data/
7 +=== Install docker on linux ===
7 7  
8 -sudo apt install docker docker-compose
9 +The installation of docker on linux is straightforward. If you Google this topic you will find explanations from the Docker website which invite you to do a manual installation of docker by downloading and installing their actual version. From a technical perspective this is not needed. At least Brinkhaus does not need bleeding edge docker installation. We recommend to just use the docker version which comes from your Linux distribution.
9 9  
11 +On a typical Ubuntu or Debian you go with
12 +
13 +(% class="box" %)
14 +(((
15 +(% class="code" %)
16 +(((
17 +sudo apt install docker-compose
18 +)))
19 +)))
20 +
21 +=== Install docker on Windows ===
22 +
23 +The installation of docker for Windows is described here: [[https:~~/~~/docs.docker.com/desktop/install/windows-install/>>url:https://docs.docker.com/desktop/install/windows-install/]]
24 +
25 += Installation =
26 +
27 +On a computer with Docker, just choose a target directory which fits for your case, deploy our docker-compose file there and start the app.
28 +
29 +**Suggestion for quick start for linux**
30 +
31 +(% class="box" %)
32 +(((
33 +(% class="code" %)
34 +(((
35 +sudo mkdir /var/docker_data
36 +cd /var/docker_data/
37 +wget https:~/~/xwiki.brinkhaus-gmbh.de/bin/download/Product%20support/FileSync/WebHome/docker-compose.yml?rev=1.1
10 10  sudo docker login registry.gitlab.com/v2/b3935 -u datastore-dl -p glpat-S9xzXzoUxuxGboW53r2x
39 +\\sudo docker-compose up -d
40 +)))
41 +)))
11 11  
12 -sudo docker-compose up
43 +You are afterwards able to log in via the web interface on port 80 of the server where you installed FileSync.
13 13  
45 +
46 +**Suggestion for quick start for Windows**
47 +
48 +Place the docker-compose file from here [[https:~~/~~/xwiki.brinkhaus-gmbh.de/bin/download/Product%20support/FileSync/WebHome/docker-compose.yml?rev=1.1>>url:https://xwiki.brinkhaus-gmbh.de/bin/download/Product%20support/FileSync/WebHome/docker-compose.yml?rev=1.1]] in a directory of your needs and run "docker-compose up -d".
49 +
50 +
51 += Variants / hints =
52 +
53 +You can adapt the docker-compose file to your local needs. The file which we give for a quick start is:
54 +
14 14  (% class="box" %)
15 15  (((
16 -##version: "3"##
57 +(% class="code" %)
58 +(((
59 +version: "3"
60 +\\services:
61 + filesync:
62 + image~: registry.gitlab.com/b3935/ftpmodule/filesync:latest
63 + container_name: filesync
64 + restart: always
65 + volumes:
66 + - ./data:/app/data
67 +\\ ports:
68 + - 80:80\\
17 17  )))
70 +)))
18 18  
72 +This results in a password-less direct access to a UI on the target server.
73 +
74 +We below give an example for enclosing FileSync with Traefik as middleware for adding an easy authentification function:
75 +
19 19  (% class="box" %)
20 20  (((
21 -##services:
78 +(% class="code" %)
79 +(((
80 +version: "3"
81 +\\services:
22 22   traefik:
23 23   image~: traefik:v2.2
24 24   command:
... ... @@ -28,35 +28,28 @@
28 28   - "80:80"
29 29   volumes:
30 30   - /var/run/docker.sock:/var/run/docker.sock
31 - - ./data:/var/docker_data/data##
32 -)))
33 -
34 -(% class="box" %)
35 -(((
36 -## filesync:
91 +# needed for using a dynamic password, settable from FileSync UI; links data/settings/ to the folder where
92 +# it is described in the "labels" of the filesync container
93 + - ./data:/var/docker_data/data
94 +\\ filesync:
37 37   image~: registry.gitlab.com/b3935/ftpmodule/filesync:latest
38 38   container_name: filesync
39 39   restart: always
40 40   volumes:
41 - - ./data:/app/data##
42 -)))
43 -
44 -(% class="box" %)
45 -(((
46 -###    ports:
47 -#      - 80:80##
48 -)))
49 -
50 -(% class="box" %)
51 -(((
52 -## labels:
99 + - ./data:/app/data
100 +\\# commented out because Traefik creates a protected rout for hisself
101 +# ports:
102 +# - 80:80
103 +\\ labels:
53 53   - "traefik.http.routers.filesync.entrypoints=web"
54 54   - "traefik.http.routers.filesync.rule=Host(`datastore-playground.euprogigant.io`)"
55 55   - "traefik.http.routers.filesync.middlewares=auth"
56 56   - "traefik.http.services.filesync.loadbalancer.server.port=80"
108 +# hard coded password; hash retrievable via "htpasswd -bnBC 10 admin PASSWORD"
57 57   - "traefik.http.middlewares.auth.basicauth.users=admin:$$2y$$10$$2u0mbq4FI.EpN6Gu5O.BpO5Fh8RrXBr.MUT8JyqbYGtNfLn19OhTe" # credentials admin:changeme
58 -#      - "traefik.http.middlewares.auth.basicauth.usersfile=/var/docker_data/data/settings/hashedPW.txt"##
110 +# dynamic password, settable from FileSync UI; needs link of data/settings/ in the docker container of Traefik
111 +# - "traefik.http.middlewares.auth.basicauth.usersfile=/var/docker_data/data/settings/hashedPW.txt"\\
59 59  )))
113 +)))
60 60  
61 61  
62 -
docker-compose.yml
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.brinkhaus
Size
... ... @@ -1,0 +1,1 @@
1 +236 bytes
Content
... ... @@ -1,0 +1,15 @@
1 +version: "3"
2 +
3 +services:
4 +
5 + filesync:
6 + image: registry.gitlab.com/b3935/ftpmodule/filesync:latest
7 + container_name: filesync
8 + restart: unless-stopped
9 +
10 + volumes:
11 + - ./data:/app/data
12 +
13 + ports:
14 + - 80:80
15 +

Navigation

Need support?

If you need support feel free to contact:

Jan Brinkhaus: 0049 179 3939 733