add local HTML documentation

generated with 'make htmldoc'
author: nodiscc <nodiscc@gmail.com> 2015-04-05 22:37:15 +0200
committer: nodiscc <nodiscc@gmail.com> 2015-04-05 22:37:15 +0200
commit: 7a32b172b82c2571d39d0b239e06d6be73b174f3 (patch)
tree: b46a4f02f67103d511671d682aa83063fded74d6 /doc/Copy-a-Shaarli-installation-over-SSH-SCP,-serve-it-locally-with-php-cli.html
parent: 82af78b272ab0036eec289eb338934736aabbdc2 (diff)
download: Shaarli-7a32b172b82c2571d39d0b239e06d6be73b174f3.tar.gz
Shaarli-7a32b172b82c2571d39d0b239e06d6be73b174f3.tar.zst
Shaarli-7a32b172b82c2571d39d0b239e06d6be73b174f3.zip
1 files changed, 75 insertions, 0 deletions
diff --git a/doc/Copy-a-Shaarli-installation-over-SSH-SCP,-serve-it-locally-with-php-cli.html b/doc/Copy-a-Shaarli-installation-over-SSH-SCP,-serve-it-locally-with-php-cli.html
new file mode 100644
index 00000000..25e4bc6b
--- /dev/null
+++ b/doc/Copy-a-Shaarli-installation-over-SSH-SCP,-serve-it-locally-with-php-cli.html
@@ -0,0 +1,75 @@
+<!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">
+  <title></title>
+  <style type="text/css">code{white-space: pre;}</style>
+  <!--[if lt IE 9]>
+    <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+  <![endif]-->
+  <link rel="stylesheet" href="github-markdown.css">
+</head>
+<body>
+<p>Example bash script:</p>
+<pre><code>#!/bin/bash
+#Description: Copy a Shaarli installation over SSH/SCP, serve it locally with php-cli
+#Will create a local-shaarli/ directory when you run it, backup your Shaarli there, and serve it locally.
+#Will NOT download linked pages. It&#39;s just a directly usable backup/copy/mirror of your Shaarli
+#Requires: ssh, scp and a working SSH access to the server where your Shaarli is installed
+#Usage: ./local-shaarli.sh
+#Author: nodiscc (nodiscc@gmail.com)
+#License: MIT (http://opensource.org/licenses/MIT)
+set -o errexit
+set -o nounset
+##### CONFIG #################
+#The port used by php&#39;s local server
+php_local_port=7431
+#Name of the SSH server and path where Shaarli is installed
+#TODO: pass these as command-line arguments
+remotehost=&quot;my.ssh.server&quot;
+remote_shaarli_dir=&quot;/var/www/shaarli&quot;
+###### FUNCTIONS #############
+_main() {
+    _CBSyncShaarli
+    _CBServeShaarli
+}
+_CBSyncShaarli() {
+    remote_temp_dir=$(ssh $remotehost mktemp -d)
+    remote_ssh_user=$(ssh $remotehost whoami)
+    ssh -t &quot;$remotehost&quot; sudo cp -r &quot;$remote_shaarli_dir&quot; &quot;$remote_temp_dir&quot;
+    ssh -t &quot;$remotehost&quot; sudo chown -R &quot;$remote_ssh_user&quot;:&quot;$remote_ssh_user&quot; &quot;$remote_temp_dir&quot;
+    scp -rq &quot;$remotehost&quot;:&quot;$remote_temp_dir&quot; local-shaarli
+    ssh &quot;$remotehost&quot; rm -r &quot;$remote_temp_dir&quot;
+}
+_CBServeShaarli() {
+    #TODO: allow serving a previously downloaded Shaarli
+    #TODO: ask before overwriting local copy, if it exists
+    cd local-shaarli/
+    php -S localhost:${php_local_port}
+    echo &quot;Please go to http://localhost:${php_local_port}&quot;
+}
+##### MAIN #################
+_main</code></pre>
+<p>This outputs:</p>
+<pre><code>$ ./local-shaarli.sh
+PHP 5.6.0RC4 Development Server started at Mon Sep  1 21:56:19 2014
+Listening on http://localhost:7431
+Document root is /home/user/local-shaarli/shaarli
+Press Ctrl-C to quit.
+[Mon Sep  1 21:56:27 2014] ::1:57868 [200]: /
+[Mon Sep  1 21:56:27 2014] ::1:57869 [200]: /index.html
+[Mon Sep  1 21:56:37 2014] ::1:57881 [200]: /...</code></pre>
+</body>
+</html>
author	nodiscc <nodiscc@gmail.com>	2015-04-05 22:37:15 +0200
committer	nodiscc <nodiscc@gmail.com>	2015-04-05 22:37:15 +0200
commit	7a32b172b82c2571d39d0b239e06d6be73b174f3 (patch)
tree	b46a4f02f67103d511671d682aa83063fded74d6 /doc/Copy-a-Shaarli-installation-over-SSH-SCP,-serve-it-locally-with-php-cli.html
parent	82af78b272ab0036eec289eb338934736aabbdc2 (diff)
download	Shaarli-7a32b172b82c2571d39d0b239e06d6be73b174f3.tar.gz Shaarli-7a32b172b82c2571d39d0b239e06d6be73b174f3.tar.zst Shaarli-7a32b172b82c2571d39d0b239e06d6be73b174f3.zip

diff --git a/doc/Copy-a-Shaarli-installation-over-SSH-SCP,-serve-it-locally-with-php-cli.html b/doc/Copy-a-Shaarli-installation-over-SSH-SCP,-serve-it-locally-with-php-cli.html new file mode 100644 index 00000000..25e4bc6b --- /dev/null +++ b/doc/Copy-a-Shaarli-installation-over-SSH-SCP,-serve-it-locally-with-php-cli.html
@@ -0,0 +1,75 @@
	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></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	<link rel="stylesheet" href="github-markdown.css">
	13	</head>
	14	<body>
	15	<p>Example bash script:</p>
	16	<pre><code>#!/bin/bash
	17	#Description: Copy a Shaarli installation over SSH/SCP, serve it locally with php-cli
	18	#Will create a local-shaarli/ directory when you run it, backup your Shaarli there, and serve it locally.
	19	#Will NOT download linked pages. It's just a directly usable backup/copy/mirror of your Shaarli
	20	#Requires: ssh, scp and a working SSH access to the server where your Shaarli is installed
	21	#Usage: ./local-shaarli.sh
	22	#Author: nodiscc (nodiscc@gmail.com)
	23	#License: MIT (http://opensource.org/licenses/MIT)
	24	set -o errexit
	25	set -o nounset
	26
	27	##### CONFIG #################
	28	#The port used by php's local server
	29	php_local_port=7431
	30
	31	#Name of the SSH server and path where Shaarli is installed
	32	#TODO: pass these as command-line arguments
	33	remotehost="my.ssh.server"
	34	remote_shaarli_dir="/var/www/shaarli"
	35
	36
	37	###### FUNCTIONS #############
	38	_main() {
	39	_CBSyncShaarli
	40	_CBServeShaarli
	41	}
	42
	43	_CBSyncShaarli() {
	44	remote_temp_dir=$(ssh $remotehost mktemp -d)
	45	remote_ssh_user=$(ssh $remotehost whoami)
	46	ssh -t "$remotehost" sudo cp -r "$remote_shaarli_dir" "$remote_temp_dir"
	47	ssh -t "$remotehost" sudo chown -R "$remote_ssh_user":"$remote_ssh_user" "$remote_temp_dir"
	48	scp -rq "$remotehost":"$remote_temp_dir" local-shaarli
	49	ssh "$remotehost" rm -r "$remote_temp_dir"
	50	}
	51
	52	_CBServeShaarli() {
	53	#TODO: allow serving a previously downloaded Shaarli
	54	#TODO: ask before overwriting local copy, if it exists
	55	cd local-shaarli/
	56	php -S localhost:${php_local_port}
	57	echo "Please go to http://localhost:${php_local_port}"
	58	}
	59
	60
	61	##### MAIN #################
	62
	63	_main</code></pre>
	64	<p>This outputs:</p>
	65	<pre><code>$ ./local-shaarli.sh
	66	PHP 5.6.0RC4 Development Server started at Mon Sep 1 21:56:19 2014
	67	Listening on http://localhost:7431
	68	Document root is /home/user/local-shaarli/shaarli
	69	Press Ctrl-C to quit.
	70
	71	[Mon Sep 1 21:56:27 2014] ::1:57868 [200]: /
	72	[Mon Sep 1 21:56:27 2014] ::1:57869 [200]: /index.html
	73	[Mon Sep 1 21:56:37 2014] ::1:57881 [200]: /...</code></pre>
	74	</body>
	75	</html>