]>
Commit | Line | Data |
---|---|---|
992af0b9 V |
1 | <!DOCTYPE html> |
2 | <html> | |
3 | <head> | |
4 | <meta charset="utf-8"> | |
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 | <!--[if lt IE 9]> | |
10 | <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> | |
11 | <![endif]--> | |
12 | <style type="text/css"> | |
13 | table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode { | |
14 | margin: 0; padding: 0; vertical-align: baseline; border: none; } | |
15 | table.sourceCode { width: 100%; line-height: 100%; } | |
16 | td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; } | |
17 | td.sourceCode { padding-left: 5px; } | |
18 | code > span.kw { color: #007020; font-weight: bold; } | |
19 | code > span.dt { color: #902000; } | |
20 | code > span.dv { color: #40a070; } | |
21 | code > span.bn { color: #40a070; } | |
22 | code > span.fl { color: #40a070; } | |
23 | code > span.ch { color: #4070a0; } | |
24 | code > span.st { color: #4070a0; } | |
25 | code > span.co { color: #60a0b0; font-style: italic; } | |
26 | code > span.ot { color: #007020; } | |
27 | code > span.al { color: #ff0000; font-weight: bold; } | |
28 | code > span.fu { color: #06287e; } | |
29 | code > span.er { color: #ff0000; font-weight: bold; } | |
30 | </style> | |
31 | <link rel="stylesheet" href="github-markdown.css"> | |
32 | </head> | |
33 | <body> | |
34 | <div id="local-sidebar"> | |
35 | <ul> | |
36 | <li><a href="Home.html">Home</a></li> | |
37 | <li>Installation | |
38 | <ul> | |
f8b936e7 | 39 | <li><a href="Download.html">Download</a></li> |
992af0b9 V |
40 | <li><a href="Server-requirements.html">Server requirements</a></li> |
41 | <li><a href="Server-configuration.html">Server configuration</a></li> | |
42 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | |
43 | </ul></li> | |
44 | <li><a href="Usage.html">Usage</a> | |
45 | <ul> | |
46 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | |
47 | <li><a href="Firefox-share.html">Firefox share</a></li> | |
48 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | |
49 | </ul></li> | |
50 | <li>How To | |
51 | <ul> | |
52 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | |
53 | <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> | |
54 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | |
6335a0fc | 55 | <li><a href="Datastore-hacks.html">Datastore hacks</a></li> |
992af0b9 V |
56 | </ul></li> |
57 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | |
58 | <li><a href="Development.html">Development</a> | |
59 | <ul> | |
60 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | |
61 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | |
62 | <li><a href="Directory-structure.html">Directory structure</a></li> | |
63 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | |
64 | <li><a href="Plugin-System.html">Plugin System</a></li> | |
65 | <li><a href="Security.html">Security</a></li> | |
66 | <li><a href="Static-analysis.html">Static analysis</a></li> | |
67 | <li><a href="Theming.html">Theming</a></li> | |
68 | <li><a href="Unit-tests.html">Unit tests</a></li> | |
69 | </ul></li> | |
70 | <li>About | |
71 | <ul> | |
72 | <li><a href="FAQ.html">FAQ</a></li> | |
73 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | |
74 | <li><a href="TODO.html">TODO</a></li> | |
75 | </ul></li> | |
76 | </ul> | |
77 | </div> | |
78 | <h1 id="copy-an-existing-installation-over-ssh-and-serve-it-locally">Copy an existing installation over SSH and serve it locally</h1> | |
79 | <p>Example bash script:</p> | |
80 | <pre class="sourceCode bash"><code class="sourceCode bash"><span class="co">#!/bin/bash</span> | |
81 | <span class="co">#Description: Copy a Shaarli installation over SSH/SCP, serve it locally with php-cli</span> | |
82 | <span class="co">#Will create a local-shaarli/ directory when you run it, backup your Shaarli there, and serve it locally.</span> | |
83 | <span class="co">#Will NOT download linked pages. It's just a directly usable backup/copy/mirror of your Shaarli</span> | |
84 | <span class="co">#Requires: ssh, scp and a working SSH access to the server where your Shaarli is installed</span> | |
85 | <span class="co">#Usage: ./local-shaarli.sh</span> | |
86 | <span class="co">#Author: nodiscc (nodiscc@gmail.com)</span> | |
87 | <span class="co">#License: MIT (http://opensource.org/licenses/MIT)</span> | |
88 | <span class="kw">set</span> <span class="kw">-o</span> errexit | |
89 | <span class="kw">set</span> <span class="kw">-o</span> nounset | |
90 | ||
91 | <span class="co">##### CONFIG #################</span> | |
92 | <span class="co">#The port used by php's local server</span> | |
93 | <span class="ot">php_local_port=</span>7431 | |
94 | ||
95 | <span class="co">#Name of the SSH server and path where Shaarli is installed</span> | |
96 | <span class="co">#TODO: pass these as command-line arguments</span> | |
97 | <span class="ot">remotehost=</span><span class="st">"my.ssh.server"</span> | |
98 | <span class="ot">remote_shaarli_dir=</span><span class="st">"/var/www/shaarli"</span> | |
99 | ||
100 | ||
101 | <span class="co">###### FUNCTIONS #############</span> | |
102 | <span class="fu">_main()</span> <span class="kw">{</span> | |
103 | <span class="kw">_CBSyncShaarli</span> | |
104 | <span class="kw">_CBServeShaarli</span> | |
105 | <span class="kw">}</span> | |
106 | ||
107 | <span class="fu">_CBSyncShaarli()</span> <span class="kw">{</span> | |
108 | <span class="ot">remote_temp_dir=$(</span><span class="kw">ssh</span> <span class="ot">$remotehost</span> mktemp -d<span class="ot">)</span> | |
109 | <span class="ot">remote_ssh_user=$(</span><span class="kw">ssh</span> <span class="ot">$remotehost</span> whoami<span class="ot">)</span> | |
110 | <span class="kw">ssh</span> -t <span class="st">"</span><span class="ot">$remotehost</span><span class="st">"</span> sudo cp -r <span class="st">"</span><span class="ot">$remote_shaarli_dir</span><span class="st">"</span> <span class="st">"</span><span class="ot">$remote_temp_dir</span><span class="st">"</span> | |
111 | <span class="kw">ssh</span> -t <span class="st">"</span><span class="ot">$remotehost</span><span class="st">"</span> sudo chown -R <span class="st">"</span><span class="ot">$remote_ssh_user</span><span class="st">"</span>:<span class="st">"</span><span class="ot">$remote_ssh_user</span><span class="st">"</span> <span class="st">"</span><span class="ot">$remote_temp_dir</span><span class="st">"</span> | |
112 | <span class="kw">scp</span> -rq <span class="st">"</span><span class="ot">$remotehost</span><span class="st">"</span>:<span class="st">"</span><span class="ot">$remote_temp_dir</span><span class="st">"</span> local-shaarli | |
113 | <span class="kw">ssh</span> <span class="st">"</span><span class="ot">$remotehost</span><span class="st">"</span> rm -r <span class="st">"</span><span class="ot">$remote_temp_dir</span><span class="st">"</span> | |
114 | <span class="kw">}</span> | |
115 | ||
116 | <span class="fu">_CBServeShaarli()</span> <span class="kw">{</span> | |
117 | <span class="co">#TODO: allow serving a previously downloaded Shaarli</span> | |
118 | <span class="co">#TODO: ask before overwriting local copy, if it exists</span> | |
119 | <span class="kw">cd</span> local-shaarli/ | |
120 | <span class="kw">php</span> -S localhost:<span class="ot">${php_local_port}</span> | |
121 | <span class="kw">echo</span> <span class="st">"Please go to http://localhost:</span><span class="ot">${php_local_port}</span><span class="st">"</span> | |
122 | <span class="kw">}</span> | |
123 | ||
124 | ||
125 | <span class="co">##### MAIN #################</span> | |
126 | ||
127 | <span class="kw">_main</span></code></pre> | |
128 | <p>This outputs:</p> | |
129 | <pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">./local-shaarli.sh</span> | |
130 | <span class="kw">PHP</span> 5.6.0RC4 Development Server started at Mon Sep 1 21:56:19 2014 | |
131 | <span class="kw">Listening</span> on http://localhost:7431 | |
132 | <span class="kw">Document</span> root is /home/user/local-shaarli/shaarli | |
133 | <span class="kw">Press</span> Ctrl-C to quit. | |
134 | ||
135 | [<span class="kw">Mon</span> Sep 1 21:56:27 2014] ::1:57868 [200]: /[](.html) | |
136 | [<span class="kw">Mon</span> Sep 1 21:56:27 2014] ::1:57869 [200]: /index.html[](.html) | |
137 | [<span class="kw">Mon</span> Sep 1 21:56:37 2014] ::1:57881 [200]: /...[](.html)</code></pre> | |
138 | </body> | |
139 | </html> |