{"result":{"depiction_url":null,"edges":{"references":{"objects":[{"created":"2020-05-30T05:48:00Z","object_id":{"id":1547,"is_a":["text","documentation","reference"],"name":"doc_reference_cli_index","title":"Command-line","uri":"https:\/\/zotonic.com\/id\/1547"},"seq":1000000}],"predicate":{"id":332,"is_a":["meta","predicate"],"name":"references","title":{"_type":"trans","tr":{"en":"References"}},"uri":"https:\/\/zotonic.com\/id\/references"}}},"id":2085,"is_a":["text","documentation","reference"],"links":[{"rel":"self","target":"https:\/\/zotonic.com\/.zotonic\/websub\/topic\/2085"},{"rel":"hub","target":"https:\/\/zotonic.com\/.zotonic\/websub"}],"medium":null,"medium_url":null,"name":"doc_reference_cli_cli_addsite","page_url":{"en":"https:\/\/zotonic.com\/docs\/2085\/the-addsite-command","x-default":"https:\/\/zotonic.com\/docs\/2085\/the-addsite-command"},"preview_url":null,"resource":{"body":"
\n \n
\n\n

Adding a site to Zotonic is done through the zotonic<\/span><\/a> shell command. It syntax is like this:<\/p>\n

<\/span>zotonic<\/span> addsite<\/span> [<\/span>options<\/span>]<\/span> <<\/span>site_name<\/span>><\/span>\n<\/pre><\/div>\n<\/div>\n
This command creates a new site with [site_name] as the site’s\nname. This new site will be based on a so-called skeleton\nsite<\/cite>. Currently there are four skeletons: ‘blog’, ‘empty’\nand ‘nodb’. ‘blog’ is the default.<\/p>\n
The addsite command is highly configurable and takes the following options:<\/p>\n\n
\n<\/col>\n<\/col>\n\n
\n-s <skel><\/var><\/span><\/kbd><\/td>\nSkeleton site (one of ‘blog’, ‘empty’, ‘nodb’; default: blog)<\/td><\/tr>\n
\n-H <host><\/var><\/span><\/kbd><\/td>\nSite’s hostname (default: <site_name>.test)<\/td><\/tr>\n
\n-L<\/span><\/kbd><\/td>\nCreate the site in the current directory and symlink it into the zotonic user directory<\/td><\/tr>\n
\n-g <remote><\/var><\/span><\/kbd><\/td>\nCreate a git repository in the site and push it to the given remote<\/td><\/tr>\n
\n-h <host><\/var><\/span><\/kbd><\/td>\nDatabase host (default: localhost)<\/td><\/tr>\n
\n-p <port><\/var><\/span><\/kbd><\/td>\nDatabase port (default: 5432)<\/td><\/tr>\n
\n-u <user><\/var><\/span><\/kbd><\/td>\nDatabase user (default: zotonic)<\/td><\/tr>\n
\n-P <pass><\/var><\/span><\/kbd><\/td>\nDatabase password (default: zotonic)<\/td><\/tr>\n
\n-d <name><\/var><\/span><\/kbd><\/td>\nDatabase name (default: zotonic)<\/td><\/tr>\n
\n-n <schema><\/var><\/span><\/kbd><\/td>\nDatabase schema (default: <site_name>)<\/td><\/tr>\n
\n-a <pass><\/var><\/span><\/kbd><\/td>\nAdmin password (default: admin)<\/td><\/tr>\n
\n-A <app><\/var><\/span><\/kbd><\/td>\nIf true, initializes a site app and a root supervisor when the site starts (default: false)<\/td><\/tr>\n
\n-U <umbrella><\/var><\/span><\/kbd><\/td>\nIf true, the site dir becomes a multi-app structure (default: false)<\/td><\/tr>\n<\/tbody>\n<\/table><\/div>\n<\/p>\n
\n
Adding a site<\/h2>\n
When adding a site, the site will be created in the Zotonic user\ndirectory. When -L<\/span><\/code> is used, the site will be created in the\ncurrent directory (from which the addsite<\/span><\/code> command is ran), and a\nsymlink into the Zotonic user directory will be made.<\/p>\n
Before adding the site, the command will print out an\noverview of what it will do before continuing.<\/p>\n
For instance, consider the following addsite command:<\/p>\n
<\/span>zotonic<\/span> addsite<\/span> -<\/span>s<\/span> blog<\/span> myfirstblog<\/span>\n<\/pre><\/div>\n<\/div>\n
Will print out the following:<\/p>\n
<\/span>************\nWarning!\n************\nSite: 'myfirstblog.test' cannot be reached.\nCommand 'host myfirstblog.test' must resolve to an IP address,\notherwise you won't be able to reach it after installing the site.\nYou can fix that by adding the following line to \/etc\/hosts:\n\n127.0.0.1         myfirstblog.test\n\n\n==== Add site ====\n\nSite name: myfirstblog\nSite URL: http:\/\/myfirstblog.test:8000\/\n\nSkeleton site: blog\nSite directory: \/home\/user\/zotonic\/apps_user\/myfirstblog\nAdmin password: admin\n\nDatabase host: 127.0.0.1\nDatabase port: 5432\nDatabase user: zotonic\nDatabase password: zotonic\nDatabase name: zotonic\nDatabase schema: myfirstblog\n\n>>> Hit return to proceed...\n<\/pre><\/div>\n<\/div>\n
First, it will warn you that the hostname that this site (initially)\nwill have, is not yet resolvable. Add the hostname to your local hosts\nfile to be able to see the site when it has finished installing.<\/p>\n
After this warning, the addsite<\/cite> command will print out an overview\nof what it will do. It will show the site name, the URL the site will\nbe reachable on, in which directory the site will be installed, et\ncetera. An overview of the database credentials and the admin password\nwill also be printed. After hitting return, the site will be created\nand built for the first time. This will take a few moments, after\nwhich you will be able to visit the site’s URL in your browser.<\/p>\n<\/div>\n
\n
Default values to zotonic addsite<\/cite><\/h2>\n
The “addsite” subcommand checks a file called\n$HOME\/.zotonic-defaults<\/span><\/code> for the default values to these\noptions. This file is a file in bash-syntax which can define the\nfollowing variables: SKEL<\/span><\/code>, DBHOST<\/span><\/code>, DBPORT<\/span><\/code>, DBUSER<\/span><\/code>,\nDBPASSWORD<\/span><\/code>, DBDATABASE<\/span><\/code>, DBSCHEMA<\/span><\/code>, ADMINPASSWORD<\/span><\/code>,\nSITEHOSTNAME<\/span><\/code>, DO_LINK<\/span><\/code>, TARGETDIR<\/span><\/code>.<\/p>\n
For instance, if you want all new Zotonic sites to be created in\n\/var\/www and have hostnames like www.mysite.intra<\/cite>,\nwww.anothersite.intra<\/cite>, add the following to your\n$HOME\/.zotonic-defaults<\/span><\/code> file:<\/p>\n
<\/span>export<\/span> SITEHOSTNAME<\/span>=<\/span>"www.%%SITE%%.intra"<\/span>\nexport<\/span> TARGETDIR<\/span>=\/<\/span>var<\/span>\/<\/span>www<\/span>\n<\/pre><\/div>\n<\/div>\n<\/div>\n
\n
Available skeleton sites<\/h2>\n
Zotonic comes with four different skeletons to base your site on.<\/p>\n
\n
blog<\/span><\/code><\/dt>\n
As a full example of a Zotonic website, it installs a front page\nwith a listing of recent articles. As default example data, three\nexample articles and a couple of images are also installed.<\/dd>\n
empty<\/span><\/code><\/dt>\n
An empty skeleton. No templates or dispatch rules whatsoever are\ncreated. You can use this skeleton to create a new site based on\nyour own base templates, a custom CSS framework, etc.<\/dd>\n
nodb<\/span><\/code><\/dt>\n
Like the empty<\/cite> template, but this skeleton does not require a\ndatabase connection. As such, the admin and content management\ninterface is disabled, as those modules all require a database\nconnection.<\/dd>\n<\/dl>\n<\/div>\n<\/div>\n\n\n           <\/div>","category_id":{"id":319,"is_a":["meta","category"],"name":"reference","title":"Reference","uri":"https:\/\/zotonic.com\/id\/reference"},"content_group_id":{"id":339,"is_a":["meta","content_group"],"name":"default_content_group","title":{"_type":"trans","tr":{"en":"Default Content Group"}},"uri":"https:\/\/zotonic.com\/id\/default_content_group"},"created":"2020-05-30T05:47:58Z","creator_id":{"id":336,"is_a":["person","robot"],"name":"gitbot","title":"Git","uri":"https:\/\/zotonic.com\/id\/336"},"github_url":"https:\/\/github.com\/zotonic\/zotonic\/tree\/master\/doc\/ref\/cli\/cli-addsite.rst","is_authoritative":true,"is_dependent":false,"is_featured":false,"is_protected":false,"is_published":true,"is_unfindable":false,"language":["en"],"modified":"2023-06-24T08:18:01Z","modifier_id":{"id":336,"is_a":["person","robot"],"name":"gitbot","title":"Git","uri":"https:\/\/zotonic.com\/id\/336"},"name":"doc_reference_cli_cli_addsite","pivot_geocode":null,"pivot_location_lat":null,"pivot_location_lng":null,"privacy":0,"publication_end":"9999-06-01T00:00:00Z","publication_start":"2023-06-24T08:18:01Z","slug":"the-addsite-command","title":"The addsite command","title_slug":"the-addsite-command","tz":"UTC","uri":null,"version":3934,"visible_for":0},"uri":"https:\/\/zotonic.com\/id\/2085","uri_template":"https:\/\/zotonic.com\/id\/:id","websub":{"hub":"https:\/\/zotonic.com\/.zotonic\/websub","topic":"https:\/\/zotonic.com\/.zotonic\/websub\/topic\/2085"}},"status":"ok"}