2015-07-22 05:02:10 +02:00
<!DOCTYPE html>
< html >
< head >
< meta charset = "utf-8" >
< meta name = "generator" content = "pandoc" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0, user-scalable=yes" >
2016-04-14 14:20:23 +02:00
< title > Shaarli – < / title >
2015-07-22 05:02:10 +02:00
< style type = "text/css" > code { white-space : pre ; } < / style >
< style type = "text/css" >
2016-04-14 14:20:23 +02:00
div.sourceCode { overflow-x: auto; }
2015-07-22 05:02:10 +02:00
table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
margin: 0; padding: 0; vertical-align: baseline; border: none; }
table.sourceCode { width: 100%; line-height: 100%; }
td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
td.sourceCode { padding-left: 5px; }
2016-04-14 14:20:23 +02:00
code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
code > span.dt { color: #902000; } /* DataType */
code > span.dv { color: #40a070; } /* DecVal */
code > span.bn { color: #40a070; } /* BaseN */
code > span.fl { color: #40a070; } /* Float */
code > span.ch { color: #4070a0; } /* Char */
code > span.st { color: #4070a0; } /* String */
code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
code > span.ot { color: #007020; } /* Other */
code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
code > span.fu { color: #06287e; } /* Function */
code > span.er { color: #ff0000; font-weight: bold; } /* Error */
code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
code > span.cn { color: #880000; } /* Constant */
code > span.sc { color: #4070a0; } /* SpecialChar */
code > span.vs { color: #4070a0; } /* VerbatimString */
code > span.ss { color: #bb6688; } /* SpecialString */
code > span.im { } /* Import */
code > span.va { color: #19177c; } /* Variable */
code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
code > span.op { color: #666666; } /* Operator */
code > span.bu { } /* BuiltIn */
code > span.ex { } /* Extension */
code > span.pp { color: #bc7a00; } /* Preprocessor */
code > span.at { color: #7d9029; } /* Attribute */
code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
2015-07-22 05:02:10 +02:00
< / style >
< link rel = "stylesheet" href = "github-markdown.css" >
2016-04-14 14:20:23 +02:00
<!-- [if lt IE 9]>
< script src = "//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js" > < / script >
<![endif]-->
2015-07-22 05:02:10 +02:00
< / head >
< body >
< div id = "local-sidebar" >
< ul >
< li > < a href = "Home.html" > Home< / a > < / li >
2016-10-12 12:36:59 +02:00
< li > Setup
2015-07-22 05:02:10 +02:00
< ul >
2016-10-12 12:36:59 +02:00
< li > < a href = "Download-and-Installation.html" > Download and Installation< / a > < / li >
< li > < a href = "Upgrade-and-migration.html" > Upgrade and migration< / a > < / li >
2015-07-22 05:02:10 +02:00
< li > < a href = "Server-requirements.html" > Server requirements< / a > < / li >
< li > < a href = "Server-configuration.html" > Server configuration< / a > < / li >
2016-04-14 14:20:23 +02:00
< li > < a href = "Server-security.html" > Server security< / a > < / li >
2015-07-22 05:02:10 +02:00
< li > < a href = "Shaarli-configuration.html" > Shaarli configuration< / a > < / li >
2016-05-14 11:37:28 +02:00
< li > < a href = "Plugins.html" > Plugins< / a > < / li >
2015-07-22 05:02:10 +02:00
< / ul > < / li >
2016-04-14 14:20:23 +02:00
< li > < a href = "Docker.html" > Docker< / a > < / li >
2015-07-22 05:02:10 +02:00
< li > < a href = "Usage.html" > Usage< / a >
< ul >
< li > < a href = "Sharing-button.html" > Sharing button< / a > (bookmarklet)< / li >
2016-04-14 14:20:23 +02:00
< li > < a href = "Browsing-and-Searching.html" > Browsing and Searching< / a > < / li >
2015-07-22 05:02:10 +02:00
< li > < a href = "Firefox-share.html" > Firefox share< / a > < / li >
< li > < a href = "RSS-feeds.html" > RSS feeds< / a > < / li >
< / ul > < / li >
< li > How To
< ul >
< li > < a href = "Backup,-restore,-import-and-export.html" > Backup, restore, import and export< / a > < / li >
< 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 >
2016-04-14 14:20:23 +02:00
< li > < a href = "Create-and-serve-multiple-Shaarlis-(farm).html" > Create and serve multiple Shaarlis (farm)< / a > < / li >
2015-07-22 05:02:10 +02:00
< li > < a href = "Download-CSS-styles-from-an-OPML-list.html" > Download CSS styles from an OPML list< / a > < / li >
2015-08-18 00:33:25 +02:00
< li > < a href = "Datastore-hacks.html" > Datastore hacks< / a > < / li >
2015-07-22 05:02:10 +02:00
< / ul > < / li >
< li > < a href = "Troubleshooting.html" > Troubleshooting< / a > < / li >
< li > < a href = "Development.html" > Development< / a >
< ul >
< li > < a href = "GnuPG-signature.html" > GnuPG signature< / a > < / li >
< li > < a href = "Coding-guidelines.html" > Coding guidelines< / a > < / li >
< li > < a href = "Directory-structure.html" > Directory structure< / a > < / li >
< li > < a href = "3rd-party-libraries.html" > 3rd party libraries< / a > < / li >
< li > < a href = "Plugin-System.html" > Plugin System< / a > < / li >
2016-04-14 14:20:23 +02:00
< li > < a href = "Release-Shaarli.html" > Release Shaarli< / a > < / li >
2015-07-22 05:02:10 +02:00
< li > < a href = "Security.html" > Security< / a > < / li >
< li > < a href = "Static-analysis.html" > Static analysis< / a > < / li >
< li > < a href = "Theming.html" > Theming< / a > < / li >
< li > < a href = "Unit-tests.html" > Unit tests< / a > < / li >
< / ul > < / li >
< li > About
< ul >
< li > < a href = "FAQ.html" > FAQ< / a > < / li >
< li > < a href = "Community-&-Related-software.html" > Community & Related software< / a > < / li >
< / ul > < / li >
< / ul >
< / div >
< h1 id = "copy-an-existing-installation-over-ssh-and-serve-it-locally" > Copy an existing installation over SSH and serve it locally< / h1 >
< p > Example bash script:< / p >
2016-04-14 14:20:23 +02:00
< div class = "sourceCode" > < pre class = "sourceCode bash" > < code class = "sourceCode bash" > < span class = "co" > #!/bin/bash< / span >
2015-07-22 05:02:10 +02:00
< span class = "co" > #Description: Copy a Shaarli installation over SSH/SCP, serve it locally with php-cli< / span >
< span class = "co" > #Will create a local-shaarli/ directory when you run it, backup your Shaarli there, and serve it locally.< / span >
< span class = "co" > #Will NOT download linked pages. It' s just a directly usable backup/copy/mirror of your Shaarli< / span >
< span class = "co" > #Requires: ssh, scp and a working SSH access to the server where your Shaarli is installed< / span >
< span class = "co" > #Usage: ./local-shaarli.sh< / span >
< span class = "co" > #Author: nodiscc (nodiscc@gmail.com)< / span >
< span class = "co" > #License: MIT (http://opensource.org/licenses/MIT)< / span >
2016-10-12 12:36:59 +02:00
< span class = "kw" > set< / span > < span class = "ex" > -o< / span > errexit
< span class = "kw" > set< / span > < span class = "ex" > -o< / span > nounset
2015-07-22 05:02:10 +02:00
< span class = "co" > ##### CONFIG #################< / span >
< span class = "co" > #The port used by php' s local server< / span >
2016-10-12 12:36:59 +02:00
< span class = "va" > php_local_port=< / span > 7431
2015-07-22 05:02:10 +02:00
< span class = "co" > #Name of the SSH server and path where Shaarli is installed< / span >
< span class = "co" > #TODO: pass these as command-line arguments< / span >
2016-10-12 12:36:59 +02:00
< span class = "va" > remotehost=< / span > < span class = "st" > " my.ssh.server" < / span >
< span class = "va" > remote_shaarli_dir=< / span > < span class = "st" > " /var/www/shaarli" < / span >
2015-07-22 05:02:10 +02:00
< span class = "co" > ###### FUNCTIONS #############< / span >
< span class = "fu" > _main()< / span > < span class = "kw" > {< / span >
2016-10-12 12:36:59 +02:00
< span class = "ex" > _CBSyncShaarli< / span >
< span class = "ex" > _CBServeShaarli< / span >
2015-07-22 05:02:10 +02:00
< span class = "kw" > }< / span >
< span class = "fu" > _CBSyncShaarli()< / span > < span class = "kw" > {< / span >
2016-10-12 12:36:59 +02:00
< span class = "va" > remote_temp_dir=$(< / span > < span class = "fu" > ssh< / span > < span class = "va" > $remotehost< / span > mktemp -d< span class = "va" > )< / span >
< span class = "va" > remote_ssh_user=$(< / span > < span class = "fu" > ssh< / span > < span class = "va" > $remotehost< / span > whoami< span class = "va" > )< / span >
< 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 >
< 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 >
< 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
< 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 >
2015-07-22 05:02:10 +02:00
< span class = "kw" > }< / span >
< span class = "fu" > _CBServeShaarli()< / span > < span class = "kw" > {< / span >
< span class = "co" > #TODO: allow serving a previously downloaded Shaarli< / span >
< span class = "co" > #TODO: ask before overwriting local copy, if it exists< / span >
2016-10-12 12:36:59 +02:00
< span class = "bu" > cd< / span > local-shaarli/
< span class = "ex" > php< / span > -S localhost:< span class = "va" > ${php_local_port}< / span >
< 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 >
2015-07-22 05:02:10 +02:00
< span class = "kw" > }< / span >
< span class = "co" > ##### MAIN #################< / span >
2016-10-12 12:36:59 +02:00
< span class = "ex" > _main< / span > < / code > < / pre > < / div >
2015-07-22 05:02:10 +02:00
< p > This outputs:< / p >
2016-10-12 12:36:59 +02:00
< div class = "sourceCode" > < pre class = "sourceCode bash" > < code class = "sourceCode bash" > $ < span class = "ex" > ./local-shaarli.sh< / span >
< span class = "ex" > PHP< / span > 5.6.0RC4 Development Server started at Mon Sep 1 21:56:19 2014
< span class = "ex" > Listening< / span > on http://localhost:7431
< span class = "ex" > Document< / span > root is /home/user/local-shaarli/shaarli
< span class = "ex" > Press< / span > Ctrl-C to quit.
2015-07-22 05:02:10 +02:00
2016-10-12 12:36:59 +02:00
[< span class = "ex" > Mon< / span > Sep 1 21:56:27 2014] ::1:57868 [200]: /[](.html)
[< span class = "ex" > Mon< / span > Sep 1 21:56:27 2014] ::1:57869 [200]: /index.html[](.html)
[< span class = "ex" > Mon< / span > Sep 1 21:56:37 2014] ::1:57881 [200]: /...[](.html)< / code > < / pre > < / div >
2015-07-22 05:02:10 +02:00
< / body >
< / html >
