From a5732b9a76013ab3dce907fae64805ce87da04e3 Mon Sep 17 00:00:00 2001 From: Brandon Mathis Date: Sun, 11 Dec 2011 00:32:57 -0600 Subject: [PATCH] updated docs for deploying with rsync --- source/docs/configuring/index.markdown | 3 +- source/docs/deploying/rsync/index.markdown | 44 ++++++++++++++----- .../index.markdown} | 8 +++- 3 files changed, 43 insertions(+), 12 deletions(-) rename source/docs/deploying/{_subdir.markdown => subdir/index.markdown} (91%) diff --git a/source/docs/configuring/index.markdown b/source/docs/configuring/index.markdown index 67bbe49..92604eb 100644 --- a/source/docs/configuring/index.markdown +++ b/source/docs/configuring/index.markdown @@ -33,6 +33,7 @@ In the `_config.yml` there are three sections for configuring your Octopress Blo subtitle: # A description used in the header author: # Your name, for RSS, Copyright, Metadata simple_search: # Search engine for simple site search + description: # A default meta description for your site subscribe_rss: # Url for your blog's feed, defauts to /atom.xml subscribe_email: # Url to subscribe by email (service required) email: # Email address for the RSS feed if you want it. @@ -67,7 +68,7 @@ These configurations are used by Jekyll and Plugins. If you're not familiar with If you want to change the way permalinks are written for your blog posts, see [Jekyll's permalink docs](https://github.com/mojombo/jekyll/wiki/Permalinks). **Note:** Jekyll has a `baseurl` config which offers mock subdirectory publishing support by adding a redirect to Jekyll's WEBrick server. **Please don't use this.** -If you want to publish your site to a subdirectory, [(see Deploying Octopress to a Subdirectory)](/docs/deploying/#deploy_subdir). +If you want to publish your site to a subdirectory, [(see Deploying Octopress to a Subdirectory)](/docs/deploying/subdir/).

3rd Party Settings

These third party integrations are already set up for you. Simply fill in the configurations and they'll be added to your site. diff --git a/source/docs/deploying/rsync/index.markdown b/source/docs/deploying/rsync/index.markdown index a0e775e..65ae4df 100644 --- a/source/docs/deploying/rsync/index.markdown +++ b/source/docs/deploying/rsync/index.markdown @@ -1,30 +1,54 @@ --- layout: page -title: "Deploying with Rsync" +title: "Deploying with rsync" date: 2011-09-10 17:53 sidebar: false footer: false --- -

Deploying with Rsync via SSH

+

Deploying with rsync via SSH

-Add your server configurations to the `Rakefile` under Rsync deploy config. To deploy with Rsync, be sure your public key is listed in your server's `~/.ssh/authorized_keys` file. +Add your server configurations to the `Rakefile` under Rsync deploy config. To deploy with rsync, be sure your public key is listed in your server's `~/.ssh/authorized_keys` file. ``` ruby - ssh_user = "user@domain.com" - document_root = "~/website.com/" - deploy_default = "rsync" +ssh_user = "user@domain.com" +document_root = "~/website.com/" +rsync_delete = true +deploy_default = "rsync" ``` Now if you run ``` sh - rake generate # If you haven't generated your blog yet - rake deploy # Syncs your blog via ssh +rake generate # If you haven't generated your blog yet +rake deploy # Syncs your blog via ssh ``` in your terminal, your `public` directory will be synced to your server's document root. +### Regarding rsync delete + +If you choose to delete on sync, rsync will create a 1:1 match. Files will be added, updated *and deleted* from your deploy directory to mirror your local copy. + +If you do not choose to delete: + +- You can store files beneath your site's deploy directory which aren't found in your local version. +- Files you have removed from your local site must be removed manually from the server. + +

Excluding files from sync

+ +If you would like to keep your Octopress files synced but also want the convenience of keeping some files or directories on the server without having to mirror them locally, you can exclude them from rsync. + +When syncing, rsync can exclude files or directories locally or on the server. Simply add an `rsync-exclude` file to the root directory of your project like this: + +```sh +some-file.txt +some-directory/ +*.mp4 +``` + +Note: using excludes will prevent rsync from uploading local files, or if the delete option is specified, it will prevent rsync from deleting excluded items on the server. + ## Version control You'll want to keep your blog source in a remote git repository, @@ -38,8 +62,8 @@ git remote add origin (your repository url) git config branch.master.remote origin ``` - {% render_partial docs/deploying/_self_hosted_git.markdown %} -{% render_partial docs/deploying/_subdir.markdown %} +## Deploying to a subdirectory +If for you wanted to host an Octopress blog at `http://yoursite.com/blog/` you would need to configure Octopress for [deploying to a subdirectory](/docs/deploying/subdir). diff --git a/source/docs/deploying/_subdir.markdown b/source/docs/deploying/subdir/index.markdown similarity index 91% rename from source/docs/deploying/_subdir.markdown rename to source/docs/deploying/subdir/index.markdown index b28a36d..99c1343 100644 --- a/source/docs/deploying/_subdir.markdown +++ b/source/docs/deploying/subdir/index.markdown @@ -1,4 +1,10 @@ -

Deploying to a Subdirectory

+--- +layout: page +title: "Deploying to a Subdirectory" +date: 2011-09-10 17:53 +sidebar: false +footer: false +--- If you're deploying to a subdirectory on your site, or if you're using Github's project pages, make sure you set up your urls correctly in your configs. You can do this *almost* automatically: