Difference between pages "ZFS Install Guide" and "Package:Ghost (Blogging Platform)"

(Difference between pages)
(Create the zpool)
 
 
Line 1: Line 1:
== Introduction ==
+
{{Ebuild
 +
|Summary=Ghost allows you to write and publish your own blog, giving you the tools to make it easy and even fun to do.
 +
|CatPkg=www-apps/ghost
 +
|Maintainer=anak1n
 +
|Homepage=https://ghost.org
 +
}}
  
This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the [[Funtoo_Linux_Installation|Regular Funtoo Installation]]. Follow the normal installation and only use this guide for steps 2, 3, and 8.
+
Ghost is an easy to use, quick, and light blogging platform that uses nodejs and is ready to go in minutes. You can configure it to do anything from a self hosted blog for yourself, a blog that uses multiple users with their own usernames and profile pages.  
  
=== Introduction to ZFS ===
+
To use Ghost in production (as opposed to development mode) you simply first run:
  
Since ZFS is a new technology for Linux, it can be helpful to understand some of its benefits, particularly in comparison to BTRFS, another popular next-generation Linux filesystem:
+
{{console|body=
 +
###i## emerge ghost
 +
###i## npm install --production
 +
}}
  
* On Linux, the ZFS code can be updated independently of the kernel to obtain the latest fixes. btrfs is exclusive to Linux and you need to build the latest kernel sources to get the latest fixes.
+
Then configure your options in {{f|/usr/share/webapps/ghost/config.example.js}} and rename it to {{f|/usr/share/webapps/ghost/config.js}}:
 +
{{file|name=config.js|lang=javascript|desc=ghost config|body=
 +
// # Ghost Configuration
 +
// Setup your Ghost install for various environments
 +
// Documentation can be found at http://support.ghost.org/config/
  
* ZFS is supported on multiple platforms. The platforms with the best support are Solaris, FreeBSD and Linux. Other platforms with varying degrees of support are NetBSD, Mac OS X and Windows. btrfs is exclusive to Linux.
+
var path = require('path'),
 +
    config;
  
* ZFS has the Adaptive Replacement Cache replacement algorithm while btrfs uses the Linux kernel's Last Recently Used replacement algorithm. The former often has an overwhelmingly superior hit rate, which means fewer disk accesses.
+
config = {
 +
    // ### Production
 +
    // When running Ghost in the wild, use the production environment
 +
    // Configure your URL and mail settings here
 +
    production: {
 +
        url: 'http://blog.somedomain.com',
 +
        mail: {
 +
            transport: 'SMTP',
 +
            options: {
 +
                service: 'Gmail',
 +
                auth: {
 +
                    user: 'user@gmail.com',
 +
                    pass: 'password'
 +
                }
 +
            }
 +
        },
 +
        database: {
 +
            client: 'sqlite3',
 +
            connection: {
 +
                filename: path.join(__dirname, '/content/data/ghost.db')
 +
            },
 +
            debug: false
 +
        },
  
* ZFS has the ZFS Intent Log and SLOG devices, which accelerates small synchronous write performance.
+
        server: {
 +
            // Host to be passed to node's `net.Server#listen()`
 +
            host: '0.0.0.0',
 +
            // Port to be passed to node's `net.Server#listen()`, for iisnode set this to `process.env.PORT`
 +
            port: '2368'
 +
        }
 +
    }
 +
};
  
* ZFS handles internal fragmentation gracefully, such that you can fill it until 100%. Internal fragmentation in btrfs can make btrfs think it is full at 10%. Btrfs has no automatic rebalancing code, so it requires a manual rebalance to correct it.
+
// Export config
 +
module.exports = config;
 +
}}
  
* ZFS has raidz, which is like RAID 5/6 (or a hypothetical RAID 7 that supports 3 parity disks), except it does not suffer from the RAID write hole issue thanks to its use of CoW and a variable stripe size. btrfs gained integrated RAID 5/6 functionality in Linux 3.9. However, its implementation uses a stripe cache that can only partially mitigate the effect of the RAID write hole.
+
{{note|You don't need to use Gmail as your mail, just an example. E-mail is only used for when you add users to the blog, it sends a notice so they can set up their own username and their own password, or if you forget your password and need to reset.}}
  
* ZFS send/receive implementation supports incremental update when doing backups. btrfs' send/receive implementation requires sending the entire snapshot.
+
After you've completed setting up your {{f|config.js}}, you can start Ghost from:
  
* ZFS supports data deduplication, which is a memory hog and only works well for specialized workloads. btrfs has no equivalent.
+
{{console|body=
 +
###i## npm start --production
 +
}}
  
* ZFS datasets have a hierarchical namespace while btrfs subvolumes have a flat namespace.
+
Once you confirm that it has started, you use the URL and port you provided in your browser: {{c|blog.somedomain.com:2368/ghost/signup}}
 +
 +
If you use Gravatar and use the e-mail used for that, it will automatically enable your Gravatar as your users avatar. You can disable this if you'd like by adding the following to your config.js
  
* ZFS has the ability to create virtual block devices called zvols in its namespace. btrfs has no equivalent and must rely on the loop device for this functionality, which is cumbersome.
+
{{file|name=config.js|lang=javascript|desc=ghost config|body=
 
+
privacy: {
The only area where btrfs is ahead of ZFS is in the area of small file
+
    useGravatar: false
efficiency. btrfs supports a feature called block suballocation, which
+
enables it to store small files far more efficiently than ZFS. It is
+
possible to use another filesystem (e.g. reiserfs) on top of a ZFS zvol
+
to obtain similar benefits (with arguably better data integrity) when
+
dealing with many small files (e.g. the portage tree).
+
 
+
For a quick tour of ZFS and have a big picture of its common operations you can consult the page [[ZFS Fun]].
+
 
+
=== Disclaimers ===
+
 
+
{{fancywarning|This guide is a work in progress. Expect some quirks.}}
+
{{fancyimportant|'''Since ZFS was really designed for 64 bit systems, we are only recommending and supporting 64 bit platforms and installations. We will not be supporting 32 bit platforms'''!}}
+
== Downloading the ISO (With ZFS) ==
+
In order for us to install Funtoo on ZFS, you will need an environment that already provides the ZFS tools. Therefore we will download a customized version of System Rescue CD with ZFS included.
+
 
+
<pre>
+
Name: sysresccd-4.2.0_zfs_0.6.2.iso  (545 MB)
+
Release Date: 2014-02-25
+
md5sum 01f4e6929247d54db77ab7be4d156d85
+
</pre>
+
 
+
 
+
'''[http://ftp.osuosl.org/pub/funtoo/distfiles/sysresccd/ Download System Rescue CD with ZFS]'''<br />
+
 
+
== Creating a bootable USB from ISO (From a Linux Environment) ==
+
After you download the iso, you can do the following steps to create a bootable USB:
+
 
+
<console>
+
Make a temporary directory
+
# ##i##mkdir /tmp/loop
+
 
+
Mount the iso
+
# ##i##mount -o ro,loop /root/sysresccd-4.2.0_zfs_0.6.2.iso /tmp/loop
+
 
+
Run the usb installer
+
# ##i##/tmp/loop/usb_inst.sh
+
</console>
+
 
+
That should be all you need to do to get your flash drive working.
+
 
+
== Booting the ISO ==
+
 
+
{{fancywarning|'''When booting into the ISO, Make sure that you select the "Alternate 64 bit kernel (altker64)". The ZFS modules have been built specifically for this kernel rather than the standard kernel. If you select a different kernel, you will get a fail to load module stack error message.'''}}
+
 
+
== Creating partitions ==
+
There are two ways to partition your disk: You can use your entire drive and let ZFS automatically partition it for you, or you can do it manually.
+
 
+
We will be showing you how to partition it '''manually''' because if you partition it manually you get to create your own layout, you get to have your own separate /boot partition (Which is nice since not every bootloader supports booting from ZFS pools), and you get to boot into RAID10, RAID5 (RAIDZ) pools and any other layouts due to you having a separate /boot partition.
+
 
+
==== gdisk (GPT Style) ====
+
 
+
'''A Fresh Start''':
+
 
+
First lets make sure that the disk is completely wiped from any previous disk labels and partitions.
+
We will also assume that <tt>/dev/sda</tt> is the target drive.<br />
+
 
+
<console>
+
# ##i##sgdisk -Z /dev/sda
+
</console>
+
 
+
{{fancywarning|This is a destructive operation and the program will not ask you for confirmation! Make sure you really don't want anything on this disk.}}
+
 
+
Now that we have a clean drive, we will create the new layout.
+
 
+
First open up the application:
+
 
+
<console>
+
# ##i##gdisk /dev/sda
+
</console>
+
 
+
'''Create Partition 1''' (boot):
+
<console>
+
Command: ##i##n ↵
+
Partition Number: ##i##↵
+
First sector: ##i##↵
+
Last sector: ##i##+250M ↵
+
Hex Code: ##i##↵
+
</console>
+
 
+
'''Create Partition 2''' (BIOS Boot Partition):
+
<console>Command: ##i##n ↵
+
Partition Number: ##i##↵
+
First sector: ##i##↵
+
Last sector: ##i##+32M ↵
+
Hex Code: ##i##EF02 ↵
+
</console>
+
 
+
'''Create Partition 3''' (ZFS):
+
<console>Command: ##i##n ↵
+
Partition Number: ##i##↵
+
First sector: ##i##↵
+
Last sector: ##i##↵
+
Hex Code: ##i##bf00 ↵
+
 
+
Command: ##i##p ↵
+
 
+
Number  Start (sector)    End (sector)  Size      Code  Name
+
  1            2048          514047  250.0 MiB  8300  Linux filesystem
+
  2          514048          579583  32.0 MiB    EF02  BIOS boot partition
+
  3          579584      1953525134  931.2 GiB  BF00  Solaris root
+
 
+
Command: ##i##w ↵
+
</console>
+
 
+
 
+
=== Format your /boot partition ===
+
 
+
<console>
+
# ##i##mkfs.ext2 -m 1 /dev/sda1
+
</console>
+
 
+
=== Create the zpool ===
+
We will first create the pool. The pool will be named  <code>tank</code>. Feel free to name your pool as you want.  We will use <code>ashift=12</code> option  which is used for a hard drives with a 4096 sector size.
+
<console># ##i## zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo tank /dev/sda3</console>
+
 
+
=== Create the zfs datasets ===
+
We will now create some datasets. For this installation, we will create a small but future proof amount of datasets. We will have a dataset for the OS (/), and your swap. We will also show you how to create some optional datasets: <tt>/home</tt>, <tt>/var</tt>, <tt>/usr/src</tt>, and <tt>/usr/portage</tt>.
+
 
+
<console>
+
Create some empty containers for organization purposes, and make the dataset that will hold /
+
# ##i##zfs create -p tank/funtoo
+
# ##i##zfs create -o mountpoint=/ tank/funtoo/root
+
 
+
Optional, but recommended datasets: /home
+
# ##i##zfs create -o mountpoint=/home tank/funtoo/home
+
 
+
Optional datasets: /usr/src, /usr/portage/{distfiles,packages}
+
# ##i##zfs create -o mountpoint=/usr/src tank/funtoo/src
+
# ##i##zfs create -o mountpoint=/usr/portage -o compression=off tank/funtoo/portage
+
# ##i##zfs create -o mountpoint=/usr/portage/distfiles tank/funtoo/portage/distfiles
+
# ##i##zfs create -o mountpoint=/usr/portage/packages tank/funtoo/portage/packages
+
</console>
+
 
+
=== Create your swap zvol ===
+
For modern machines that have greater than 4 GB of RAM, A swap size of 2G should be enough. However if your machine doesn't have a lot of RAM, the rule of thumb is either 2x the RAM or RAM + 1 GB.
+
 
+
For this tutorial we will assume that it is a newer machine and make a 2 GB swap.
+
 
+
<console>
+
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 2G tank/swap
+
</console>
+
{{fancywarning|ZFS swap is not stable and should be used with precautions.}}
+
 
+
=== Format your swap zvol ===
+
<console>
+
# ##i##mkswap -f /dev/zvol/tank/swap
+
# ##i##swapon /dev/zvol/tank/swap
+
</console>
+
 
+
Now we will continue to install funtoo.
+
 
+
== Installing Funtoo ==
+
 
+
=== Pre-Chroot ===
+
 
+
<console>
+
Go into the directory that you will chroot into
+
# ##i##cd /mnt/funtoo
+
 
+
Make a boot folder and mount your boot drive
+
# ##i##mkdir boot
+
# ##i##mount /dev/sda1 boot
+
</console>
+
 
+
[[Funtoo_Linux_Installation|Now download and extract the Funtoo stage3 ...]]
+
 
+
Once you've extracted the stage3, do a few more preparations and chroot into your new funtoo environment:
+
 
+
<console>
+
Bind the kernel related directories
+
# ##i##mount -t proc none proc
+
# ##i##mount --rbind /dev dev
+
# ##i##mount --rbind /sys sys
+
 
+
Copy network settings
+
# ##i##cp -f /etc/resolv.conf etc
+
 
+
Make the zfs folder in 'etc' and copy your zpool.cache
+
# ##i##mkdir etc/zfs
+
# ##i##cp /etc/zfs/zpool.cache etc/zfs
+
 
+
Chroot into Funtoo
+
# ##i##env -i HOME=/root TERM=$TERM chroot . bash -l
+
</console>
+
 
+
=== In Chroot ===
+
Sync your tree
+
<console>
+
# ##i##emerge --sync
+
</console>
+
 
+
=== Add filesystems to /etc/fstab ===
+
 
+
Before we continue to compile and or install our kernel in the next step, we will edit the <tt>/etc/fstab</tt> file because if we decide to install our kernel through portage, portage will need to know where our <tt>/boot</tt> is, so that it can place the files in there.
+
 
+
Edit <tt>/etc/fstab</tt>:
+
 
+
<pre>
+
# <fs>                  <mountpoint>    <type>          <opts>          <dump/pass>
+
 
+
/dev/sda1              /boot          ext2            defaults        0 2
+
/dev/zvol/tank/swap    none            swap            sw              0 0
+
</pre>
+
 
+
== Kernel Configuration ==
+
...wip
+
 
+
== Installing the ZFS userspace tools and kernel modules ==
+
Emerge {{Package|sys-fs/zfs}}. This package will bring in {{Package|sys-kernel/spl}}, and {{Package|sys-fs/zfs-kmod}} as its dependencies:
+
 
+
<console>
+
# ##i##emerge zfs
+
</console>
+
 
+
Check to make sure that the zfs tools are working. The <code>zpool.cache</code> file that you copied before should be displayed.
+
 
+
<console>
+
# ##i##zpool status
+
# ##i##zfs list
+
</console>
+
 
+
If everything worked, continue.
+
 
+
== Create the initramfs ==
+
=== genkernel ===
+
Install genkernel and run it:
+
<console>
+
# ##i##emerge genkernel
+
 
+
You only need to add --luks if you used encryption
+
# ##i##genkernel --zfs --luks initramfs
+
</console>
+
 
+
== Installing & Configuring the Bootloader ==
+
 
+
=== GRUB 2  ===
+
<console>
+
# ##i##emerge grub
+
</console>
+
 
+
Now install grub to the drive itself (not a partition):
+
<console>
+
# ##i##grub-install /dev/sda
+
</console>
+
 
+
=== boot-update ===
+
boot-update comes as a dependency of grub2, so if you already installed grub, it's already on your system!
+
 
+
==== Genkernel ====
+
If your using genkernel you must add 'real_root=ZFS=<root>' and 'dozfs' to your params.
+
Example entry for <code>/etc/boot.conf</code>:
+
 
+
{{file|name=/etc/boot.conf|desc= |body=
+
"Funtoo ZFS" {
+
        kernel kernel[-v]
+
        initrd initramfs-genkernel-x86_64[-v]
+
        params real_root=ZFS=tank/funtoo/root
+
        params += dozfs=force
+
 
}
 
}
 
}}
 
}}
  
After editing /etc/boot.conf, you just need to run boot-update to update grub.cfg
+
After this is all done, you can start using your blog. To use it you go to the domain your provided in {{c|config.js}}: {{c|blog.somedomain.com:2368/ghost}} and you will be able to publish, write drafts, and edit any posts.  
 
+
<console>
+
###i## boot-update
+
</console>
+
 
+
== Final configuration ==
+
=== Add the zfs tools to openrc ===
+
<console># ##i##rc-update add zfs boot</console>
+
 
+
=== Clean up and reboot ===
+
We are almost done, we are just going to clean up, '''set our root password''', and unmount whatever we mounted and get out.
+
 
+
<console>
+
Delete the stage3 tarball that you downloaded earlier so it doesn't take up space.
+
# ##i##cd /
+
# ##i##rm stage3-latest.tar.xz
+
 
+
Set your root password
+
# ##i##passwd
+
>> Enter your password, you won't see what you are writing (for security reasons), but it is there!
+
 
+
Get out of the chroot environment
+
# ##i##exit
+
 
+
Unmount all the kernel filesystem stuff and boot (if you have a separate /boot)
+
# ##i##umount -l proc dev sys boot
+
 
+
Turn off the swap
+
# ##i##swapoff /dev/zvol/tank/swap
+
 
+
Export the zpool
+
# ##i##cd /
+
# ##i##zpool export tank
+
 
+
Reboot
+
# ##i##reboot
+
</console>
+
 
+
{{fancyimportant|'''Don't forget to set your root password as stated above before exiting chroot and rebooting. If you don't set the root password, you won't be able to log into your new system.'''}}
+
 
+
and that should be enough to get your system to boot on ZFS.
+
 
+
== After reboot ==
+
 
+
=== Forgot to reset password? ===
+
==== System Rescue CD ====
+
If you aren't using bliss-initramfs, then you can reboot back into your sysresccd and reset through there by mounting your drive, chrooting, and then typing passwd.  
+
 
+
Example:
+
<console>
+
# ##i##zpool import -f -R /mnt/funtoo tank
+
# ##i##chroot /mnt/funtoo bash -l
+
# ##i##passwd
+
# ##i##exit
+
# ##i##zpool export -f tank
+
# ##i##reboot
+
</console>
+
 
+
=== Create initial ZFS Snapshot ===
+
Continue to set up anything you need in terms of /etc configurations. Once you have everything the way you like it, take a snapshot of your system. You will be using this snapshot to revert back to this state if anything ever happens to your system down the road. The snapshots are cheap, and almost instant.
+
 
+
To take the snapshot of your system, type the following:
+
<console># ##i##zfs snapshot -r tank@install</console>
+
 
+
To see if your snapshot was taken, type:
+
<console># ##i##zfs list -t snapshot</console>
+
 
+
If your machine ever fails and you need to get back to this state, just type (This will only revert your / dataset while keeping the rest of your data intact):
+
<console># ##i##zfs rollback tank/funtoo/root@install</console>
+
 
+
{{fancyimportant|'''For a detailed overview, presentation of ZFS' capabilities, as well as usage examples, please refer to the [[ZFS_Fun|ZFS Fun]] page.'''}}
+
 
+
== Troubleshooting ==
+
 
+
=== Starting from scratch ===
+
If your installation has gotten screwed up for whatever reason and you need a fresh restart, you can do the following from sysresccd to start fresh:
+
 
+
<console>
+
Destroy the pool and any snapshots and datasets it has
+
# ##i##zpool destroy -R -f tank
+
 
+
This deletes the files from /dev/sda1 so that even after we zap, recreating the drive in the exact sector
+
position and size will not give us access to the old files in this partition.
+
# ##i##mkfs.ext2 /dev/sda1
+
# ##i##sgdisk -Z /dev/sda
+
</console>
+
 
+
Now start the guide again :).
+
 
+
[[Category:HOWTO]]
+
[[Category:Filesystems]]
+
[[Category:Featured]]
+
[[Category:Install]]
+
  
__NOTITLE__
+
{{EbuildFooter}}

Revision as of 08:34, January 19, 2015

www-apps/ghost


Current Maintainer(s):anak1n c
Source Repository:Funtoo Overlay
Homepage

Summary: Ghost allows you to write and publish your own blog, giving you the tools to make it easy and even fun to do.


News

Drobbins

Pre-built kernels!

Funtoo stage3's are now starting to offer pre-built kernels for ease of install. read more....
12 May 2015 by Drobbins
Drobbins

Better Experiences: Ego and Vim

Info on Funtoo's new personality tool called 'ego', and user-focused updates to vim's defaults.
27 April 2015 by Drobbins
Drobbins

How We're Keeping You At the Center of the Funtoo Universe

Read about recent developments that keep you, our users, at the forefront of our focus as Funtoo moves forward.
10 April 2015 by Drobbins
View More News...

Ghost (Blogging Platform)

Tip

This is a wiki page. To edit it, Create a Funtoo account. Then log in and then click here to edit this page. See our editing guidelines to becoming a wiki-editing pro.


Ghost is an easy to use, quick, and light blogging platform that uses nodejs and is ready to go in minutes. You can configure it to do anything from a self hosted blog for yourself, a blog that uses multiple users with their own usernames and profile pages.

To use Ghost in production (as opposed to development mode) you simply first run:

# emerge ghost
# npm install --production


Then configure your options in /usr/share/webapps/ghost/config.example.js and rename it to /usr/share/webapps/ghost/config.js:

config.js (javascript source code) - ghost config
// # Ghost Configuration
// Setup your Ghost install for various environments
// Documentation can be found at http://support.ghost.org/config/
 
var path = require('path'),
    config;
 
config = {
    // ### Production
    // When running Ghost in the wild, use the production environment
    // Configure your URL and mail settings here
    production: {
        url: 'http://blog.somedomain.com',
        mail: {
            transport: 'SMTP',
            options: {
                service: 'Gmail',
                auth: {
                    user: 'user@gmail.com',
                    pass: 'password'
                }
            }
        },
        database: {
            client: 'sqlite3',
            connection: {
                filename: path.join(__dirname, '/content/data/ghost.db')
            },
            debug: false
        },
 
        server: {
            // Host to be passed to node's `net.Server#listen()`
            host: '0.0.0.0',
            // Port to be passed to node's `net.Server#listen()`, for iisnode set this to `process.env.PORT`
            port: '2368'
        }
    }
};
 
// Export config
module.exports = config;
Note

You don't need to use Gmail as your mail, just an example. E-mail is only used for when you add users to the blog, it sends a notice so they can set up their own username and their own password, or if you forget your password and need to reset.

After you've completed setting up your config.js, you can start Ghost from:

# npm start --production


Once you confirm that it has started, you use the URL and port you provided in your browser: blog.somedomain.com:2368/ghost/signup

If you use Gravatar and use the e-mail used for that, it will automatically enable your Gravatar as your users avatar. You can disable this if you'd like by adding the following to your config.js

config.js (javascript source code) - ghost config
privacy: {
    useGravatar: false
}

After this is all done, you can start using your blog. To use it you go to the domain your provided in config.js: blog.somedomain.com:2368/ghost and you will be able to publish, write drafts, and edit any posts.