5 <meta name=
"generator" content=
"pandoc">
6 <meta name=
"viewport" content=
"width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli – Copy an existing installation over SSH and serve it locally
</title>
8 <style type=
"text/css">code{white-space: pre;}
</style>
9 <style type=
"text/css">
10 div.sourceCode { overflow-x: auto; }
11 table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
12 margin:
0; padding:
0; vertical-align: baseline; border: none; }
13 table.sourceCode { width:
100%; line-height:
100%; }
14 td.lineNumbers { text-align: right; padding-right:
4px; padding-left:
4px; color: #aaaaaa; border-right:
1px solid #aaaaaa; }
15 td.sourceCode { padding-left:
5px; }
16 code
> span.kw { color: #
007020; font-weight: bold; } /* Keyword */
17 code
> span.dt { color: #
902000; } /* DataType */
18 code
> span.dv { color: #
40a070; } /* DecVal */
19 code
> span.bn { color: #
40a070; } /* BaseN */
20 code
> span.fl { color: #
40a070; } /* Float */
21 code
> span.ch { color: #
4070a0; } /* Char */
22 code
> span.st { color: #
4070a0; } /* String */
23 code
> span.co { color: #
60a0b0; font-style: italic; } /* Comment */
24 code
> span.ot { color: #
007020; } /* Other */
25 code
> span.al { color: #ff0000; font-weight: bold; } /* Alert */
26 code
> span.fu { color: #
06287e; } /* Function */
27 code
> span.er { color: #ff0000; font-weight: bold; } /* Error */
28 code
> span.wa { color: #
60a0b0; font-weight: bold; font-style: italic; } /* Warning */
29 code
> span.cn { color: #
880000; } /* Constant */
30 code
> span.sc { color: #
4070a0; } /* SpecialChar */
31 code
> span.vs { color: #
4070a0; } /* VerbatimString */
32 code
> span.ss { color: #bb6688; } /* SpecialString */
33 code
> span.im { } /* Import */
34 code
> span.va { color: #
19177c; } /* Variable */
35 code
> span.cf { color: #
007020; font-weight: bold; } /* ControlFlow */
36 code
> span.op { color: #
666666; } /* Operator */
37 code
> span.bu { } /* BuiltIn */
38 code
> span.ex { } /* Extension */
39 code
> span.pp { color: #bc7a00; } /* Preprocessor */
40 code
> span.at { color: #
7d9029; } /* Attribute */
41 code
> span.do { color: #ba2121; font-style: italic; } /* Documentation */
42 code
> span.an { color: #
60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
43 code
> span.cv { color: #
60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
44 code
> span.in { color: #
60a0b0; font-weight: bold; font-style: italic; } /* Information */
46 <link rel=
"stylesheet" href=
"github-markdown.css">
48 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
52 <div id=
"local-sidebar">
54 <li><a href=
"Home.html">Home
</a></li>
57 <li><a href=
"Download-and-Installation.html">Download and Installation
</a></li>
58 <li><a href=
"Upgrade-and-migration.html">Upgrade and migration
</a></li>
59 <li><a href=
"Server-requirements.html">Server requirements
</a></li>
60 <li><a href=
"Server-configuration.html">Server configuration
</a></li>
61 <li><a href=
"Server-security.html">Server security
</a></li>
62 <li><a href=
"Shaarli-configuration.html">Shaarli configuration
</a></li>
63 <li><a href=
"Plugins.html">Plugins
</a></li>
65 <li><a href=
"Docker.html">Docker
</a></li>
66 <li><a href=
"Usage.html">Usage
</a>
68 <li><a href=
"Sharing-button.html">Sharing button
</a> (bookmarklet)
</li>
69 <li><a href=
"Browsing-and-Searching.html">Browsing and Searching
</a></li>
70 <li><a href=
"Firefox-share.html">Firefox share
</a></li>
71 <li><a href=
"RSS-feeds.html">RSS feeds
</a></li>
75 <li><a href=
"Backup,-restore,-import-and-export.html">Backup, restore, import and export
</a></li>
76 <li><a href=
"Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally
</a></li>
77 <li><a href=
"Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)
</a></li>
78 <li><a href=
"Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list
</a></li>
79 <li><a href=
"Datastore-hacks.html">Datastore hacks
</a></li>
81 <li><a href=
"Troubleshooting.html">Troubleshooting
</a></li>
82 <li><a href=
"Development.html">Development
</a>
84 <li><a href=
"GnuPG-signature.html">GnuPG signature
</a></li>
85 <li><a href=
"Coding-guidelines.html">Coding guidelines
</a></li>
86 <li><a href=
"Directory-structure.html">Directory structure
</a></li>
87 <li><a href=
"3rd-party-libraries.html">3rd party libraries
</a></li>
88 <li><a href=
"Plugin-System.html">Plugin System
</a></li>
89 <li><a href=
"Release-Shaarli.html">Release Shaarli
</a></li>
90 <li><a href=
"Security.html">Security
</a></li>
91 <li><a href=
"Static-analysis.html">Static analysis
</a></li>
92 <li><a href=
"Theming.html">Theming
</a></li>
93 <li><a href=
"Unit-tests.html">Unit tests
</a></li>
97 <li><a href=
"FAQ.html">FAQ
</a></li>
98 <li><a href=
"Community-&-Related-software.html">Community
& Related software
</a></li>
102 <h1 id=
"copy-an-existing-installation-over-ssh-and-serve-it-locally">Copy an existing installation over SSH and serve it locally
</h1>
103 <p>Example bash script:
</p>
104 <div class=
"sourceCode"><pre class=
"sourceCode bash"><code class=
"sourceCode bash"><span class=
"co">#!/bin/bash
</span>
105 <span class=
"co">#Description: Copy a Shaarli installation over SSH/SCP, serve it locally with php-cli
</span>
106 <span class=
"co">#Will create a local-shaarli/ directory when you run it, backup your Shaarli there, and serve it locally.
</span>
107 <span class=
"co">#Will NOT download linked pages. It
's just a directly usable backup/copy/mirror of your Shaarli
</span>
108 <span class=
"co">#Requires: ssh, scp and a working SSH access to the server where your Shaarli is installed
</span>
109 <span class=
"co">#Usage: ./local-shaarli.sh
</span>
110 <span class=
"co">#Author: nodiscc (nodiscc@gmail.com)
</span>
111 <span class=
"co">#License: MIT (http://opensource.org/licenses/MIT)
</span>
112 <span class=
"kw">set
</span> <span class=
"ex">-o
</span> errexit
113 <span class=
"kw">set
</span> <span class=
"ex">-o
</span> nounset
115 <span class=
"co">##### CONFIG #################
</span>
116 <span class=
"co">#The port used by php
's local server
</span>
117 <span class=
"va">php_local_port=
</span>7431
119 <span class=
"co">#Name of the SSH server and path where Shaarli is installed
</span>
120 <span class=
"co">#TODO: pass these as command-line arguments
</span>
121 <span class=
"va">remotehost=
</span><span class=
"st">"my.ssh.server
"</span>
122 <span class=
"va">remote_shaarli_dir=
</span><span class=
"st">"/var/www/shaarli
"</span>
125 <span class=
"co">###### FUNCTIONS #############
</span>
126 <span class=
"fu">_main()
</span> <span class=
"kw">{
</span>
127 <span class=
"ex">_CBSyncShaarli
</span>
128 <span class=
"ex">_CBServeShaarli
</span>
129 <span class=
"kw">}
</span>
131 <span class=
"fu">_CBSyncShaarli()
</span> <span class=
"kw">{
</span>
132 <span class=
"va">remote_temp_dir=$(
</span><span class=
"fu">ssh
</span> <span class=
"va">$remotehost
</span> mktemp -d
<span class=
"va">)
</span>
133 <span class=
"va">remote_ssh_user=$(
</span><span class=
"fu">ssh
</span> <span class=
"va">$remotehost
</span> whoami
<span class=
"va">)
</span>
134 <span class=
"fu">ssh
</span> -t
<span class=
"st">"</span><span class=
"va">$remotehost
</span><span class=
"st">"</span> sudo cp -r
<span class=
"st">"</span><span class=
"va">$remote_shaarli_dir
</span><span class=
"st">"</span> <span class=
"st">"</span><span class=
"va">$remote_temp_dir
</span><span class=
"st">"</span>
135 <span class=
"fu">ssh
</span> -t
<span class=
"st">"</span><span class=
"va">$remotehost
</span><span class=
"st">"</span> sudo chown -R
<span class=
"st">"</span><span class=
"va">$remote_ssh_user
</span><span class=
"st">"</span>:
<span class=
"st">"</span><span class=
"va">$remote_ssh_user
</span><span class=
"st">"</span> <span class=
"st">"</span><span class=
"va">$remote_temp_dir
</span><span class=
"st">"</span>
136 <span class=
"fu">scp
</span> -rq
<span class=
"st">"</span><span class=
"va">$remotehost
</span><span class=
"st">"</span>:
<span class=
"st">"</span><span class=
"va">$remote_temp_dir
</span><span class=
"st">"</span> local-shaarli
137 <span class=
"fu">ssh
</span> <span class=
"st">"</span><span class=
"va">$remotehost
</span><span class=
"st">"</span> rm -r
<span class=
"st">"</span><span class=
"va">$remote_temp_dir
</span><span class=
"st">"</span>
138 <span class=
"kw">}
</span>
140 <span class=
"fu">_CBServeShaarli()
</span> <span class=
"kw">{
</span>
141 <span class=
"co">#TODO: allow serving a previously downloaded Shaarli
</span>
142 <span class=
"co">#TODO: ask before overwriting local copy, if it exists
</span>
143 <span class=
"bu">cd
</span> local-shaarli/
144 <span class=
"ex">php
</span> -S localhost:
<span class=
"va">${php_local_port}
</span>
145 <span class=
"bu">echo
</span> <span class=
"st">"Please go to http://localhost:
</span><span class=
"va">${php_local_port}
</span><span class=
"st">"</span>
146 <span class=
"kw">}
</span>
149 <span class=
"co">##### MAIN #################
</span>
151 <span class=
"ex">_main
</span></code></pre></div>
153 <div class=
"sourceCode"><pre class=
"sourceCode bash"><code class=
"sourceCode bash">$
<span class=
"ex">./local-shaarli.sh
</span>
154 <span class=
"ex">PHP
</span> 5.6.0RC4 Development Server started at Mon Sep
1 21:
56:
19 2014
155 <span class=
"ex">Listening
</span> on http://localhost:
7431
156 <span class=
"ex">Document
</span> root is /home/user/local-shaarli/shaarli
157 <span class=
"ex">Press
</span> Ctrl-C to quit.
159 [
<span class=
"ex">Mon
</span> Sep
1 21:
56:
27 2014] ::
1:
57868 [
200]: /[](.html)
160 [
<span class=
"ex">Mon
</span> Sep
1 21:
56:
27 2014] ::
1:
57869 [
200]: /index.html[](.html)
161 [
<span class=
"ex">Mon
</span> Sep
1 21:
56:
37 2014] ::
1:
57881 [
200]: /...[](.html)
</code></pre></div>