doc/book/en/tutorials/base/blog-in-five-minutes.rst
branchstable
changeset 6837 7562418985ef
parent 6835 87e2641d75f7
equal deleted inserted replaced
6836:fb3633142d8f 6837:7562418985ef
     8 For Debian or Ubuntu users, first install the following packages
     8 For Debian or Ubuntu users, first install the following packages
     9 (:ref:`DebianInstallation`)::
     9 (:ref:`DebianInstallation`)::
    10 
    10 
    11     cubicweb, cubicweb-dev, cubicweb-blog
    11     cubicweb, cubicweb-dev, cubicweb-blog
    12 
    12 
    13 For Windows or Mac OS X users, you must install |cubicweb| from source (see
    13 Windows or Mac OS X users must install |cubicweb| from source (see
    14 :ref:`SourceInstallation` and :ref:`WindowsInstallation`).
    14 :ref:`SourceInstallation` and :ref:`WindowsInstallation`).
    15 
    15 
    16 Then create and initialize your instance::
    16 Then create and initialize your instance::
    17 
    17 
    18     cubicweb-ctl create blog myblog
    18     cubicweb-ctl create blog myblog
    19 
    19 
    20 You'll be asked a few questions, and you can keep the default answer for most of
    20 You'll be asked a few questions, and you can keep the default answer for most of
    21 them. The one question you'll have to think about is the database you'll want to
    21 them. The one question you'll have to think about is the database you'll want to
    22 use for that instance. For a quick test, if you don't have `postgresql` installed
    22 use for that instance. For a quick test, if you don't have `postgresql` installed
    23 and configured (see :ref:`PostgresqlConfiguration`), it's higly recommended to
    23 and configured (see :ref:`PostgresqlConfiguration`), it's highly recommended to
    24 choose `sqlite` when asked for which database driber to use, since it has a much
    24 choose `sqlite` when asked for which database driver to use, since it has a much
    25 simple setup (no database server needed).
    25 simple setup (no database server needed).
    26 
    26 
    27 One the process is completed (including database initialisation), you can start
    27 One the process is completed (including database initialisation), you can start
    28 your instance by using: ::
    28 your instance by using: ::
    29 
    29 
    30     cubicweb-ctl start -D myblog
    30     cubicweb-ctl start -D myblog
    31 
    31 
    32 The `-D` option activate the debugging mode, removing it will launch the instance
    32 The `-D` option activates the debugging mode. Removing it will launch the instance
    33 as a daemon in the background.
    33 as a daemon in the background, and ``cubicweb-ctl stop myblog`` will stop
       
    34 it in that case. 
    34 
    35 
    35 
    36 
    36 About file-system permissions
    37 About file system permissions
    37 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    38 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    38 
    39 
    39 Unless you installed from sources, above commands assumes that you have root
    40 Unless you installed from sources, the above commands assume that you have root
    40 access to the :file:`/etc/` path. In order to initialize your instance as a
    41 access to the :file:`/etc/` directory. In order to initialize your instance as a
    41 regulary user, within your home directory, you can use the :envvar:`CW_MODE`
    42 regular user, within your home directory, you can use the :envvar:`CW_MODE`
    42 environment variable: ::
    43 environment variable: ::
    43 
    44 
    44   export CW_MODE=user
    45   export CW_MODE=user
    45 
    46 
    46 then create a :file:`~/etc/cubicweb.d` directory that will hold your instances.
    47 then create a :file:`~/etc/cubicweb.d` directory that will hold your instances.
    47 
    48 
    48 More information about how to configure your own environment in :ref:`ResourceMode`.
    49 More information about how to configure your own environment is
       
    50 available in :ref:`ResourceMode`.
    49 
    51 
    50 
    52 
    51 Instance parameters
    53 Instance parameters
    52 ~~~~~~~~~~~~~~~~~~~
    54 ~~~~~~~~~~~~~~~~~~~
    53 
    55 
    57 
    59 
    58 Then relaunch the database creation::
    60 Then relaunch the database creation::
    59 
    61 
    60      cubicweb-ctl db-create myblog
    62      cubicweb-ctl db-create myblog
    61 
    63 
    62 Other paramaters, like web server or emails parameters, can be modified in the
    64 Other parameters, like web server or emails parameters, can be modified in the
    63 :file:`/etc/cubicweb.d/myblog/all-in-one.conf` file.
    65 :file:`/etc/cubicweb.d/myblog/all-in-one.conf` file.
    64 
    66 
    65 You'll have to restart the instance after modification in one of those files.
    67 You'll have to restart the instance after modification in one of those files.
    66 
    68 
    67 This is it. Your blog is functionnal and running. Visit http://localhost:8080 and enjoy it!
    69 This is it. Your blog is functional and running. Visit http://localhost:8080 and enjoy it!
    68 
    70