doc/book/en/admin/create-instance.rst
changeset 10111 99863d0cbb10
parent 5317 ab757d9be796
equal deleted inserted replaced
10110:f601d2fdeff7 10111:99863d0cbb10
    10 browser. We will use a `all-in-one` configuration to simplify things ::
    10 browser. We will use a `all-in-one` configuration to simplify things ::
    11 
    11 
    12   cubicweb-ctl create -c all-in-one mycube myinstance
    12   cubicweb-ctl create -c all-in-one mycube myinstance
    13 
    13 
    14 .. note::
    14 .. note::
    15   Please note that we created a new cube for a demo purpose but
    15   Please note that we created a new cube for a demo purposes but
    16   you could have use an existing cube available in our standard library
    16   you could have used an existing cube available in our standard library
    17   such as blog or person for example.
    17   such as blog or person for example.
    18 
    18 
    19 A serie of questions will be prompted to you, the default answer is usually
    19 A series of questions will be prompted to you, the default answer is usually
    20 sufficient. You can anyway modify the configuration later on by editing
    20 sufficient. You can anyway modify the configuration later on by editing
    21 configuration files. When a user/psswd is requested to access the database
    21 configuration files. When a login/password are requested to access the database
    22 please use the login you create at the time you configured the database
    22 please use the credentials you created at the time you configured the database
    23 (:ref:`PostgresqlConfiguration`).
    23 (:ref:`PostgresqlConfiguration`).
    24 
    24 
    25 It is important to distinguish here the user used to access the database and the
    25 It is important to distinguish here the user used to access the database and the
    26 user used to login to the cubicweb instance. When an instance starts, it uses
    26 user used to login to the cubicweb instance. When an instance starts, it uses
    27 the login/psswd for the database to get the schema and handle low level
    27 the login/password for the database to get the schema and handle low level
    28 transaction. But, when :command:`cubicweb-ctl create` asks for a manager
    28 transaction. But, when :command:`cubicweb-ctl create` asks for a manager
    29 login/psswd of *CubicWeb*, it refers to the user you will use during the
    29 login/psswd of *CubicWeb*, it refers to the user you will use during the
    30 development to administrate your web instance. It will be possible, later on,
    30 development to administrate your web instance. It will be possible, later on,
    31 to use this user to create others users for your final web instance.
    31 to use this user to create other users for your final web instance.
    32 
    32 
    33 
    33 
    34 Instance administration
    34 Instance administration
    35 -----------------------
    35 -----------------------
    36 
    36 
    47 running in server mode and does not disconnect from the terminal,
    47 running in server mode and does not disconnect from the terminal,
    48 which simplifies debugging in case the instance is not properly
    48 which simplifies debugging in case the instance is not properly
    49 launched. You can see how it looks by visiting the URL
    49 launched. You can see how it looks by visiting the URL
    50 `http://localhost:8080` (the port number depends of your
    50 `http://localhost:8080` (the port number depends of your
    51 configuration). To login, please use the cubicweb administrator
    51 configuration). To login, please use the cubicweb administrator
    52 login/psswd you defined when you created the instance.
    52 login/password you defined when you created the instance.
    53 
    53 
    54 To shutdown the instance, Crtl-C in the terminal window is enough.
    54 To shutdown the instance, Crtl-C in the terminal window is enough.
    55 If you did not use the option `-D`, then type ::
    55 If you did not use the option `-D`, then type ::
    56 
    56 
    57   cubicweb-ctl stop myinstance
    57   cubicweb-ctl stop myinstance
    66   info` to filter out all logs under `info` gravity.
    66   info` to filter out all logs under `info` gravity.
    67 
    67 
    68 upgrade
    68 upgrade
    69 ~~~~~~~
    69 ~~~~~~~
    70 
    70 
    71 The command is::
    71 A manual upgrade step is necessary whenever a new version of CubicWeb or
       
    72 a cube is installed, in order to synchronise the instance's
       
    73 configuration and schema with the new code.  The command is::
    72 
    74 
    73   cubicweb-ctl upgrade myinstance
    75   cubicweb-ctl upgrade myinstance
    74 
    76 
    75 A series of questions will be asked. It always starts with a proposal
    77 A series of questions will be asked. It always starts with a proposal
    76 to make a backup of your sources (where it applies). Unless you know
    78 to make a backup of your sources (where it applies). Unless you know
    91 
    93 
    92 * fix the bug, restore the database and restart the migration process
    94 * fix the bug, restore the database and restart the migration process
    93   from scratch (quite recommended in a production environement)
    95   from scratch (quite recommended in a production environement)
    94 
    96 
    95 * try to replay the migration up to the last successful commit, that
    97 * try to replay the migration up to the last successful commit, that
    96   is answering NO to all question up to the step that failed, and
    98   is answering NO to all questions up to the step that failed, and
    97   finish by answering YES to the remaining questions.
    99   finish by answering YES to the remaining questions.
    98 
   100