1
0
mirror of https://github.com/taigaio/taiga-doc synced 2025-10-06 00:32:40 +02:00
Files
taiga-doc/setup-development.html
David Barragán Merino 370850b37c Update doc
2024-04-03 21:43:13 +02:00

1062 lines
60 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<script src="js/mlpushmenu.js" type="text/javascript"></script>
<script src="js/modernizr.custom.js" type="text/javascript"></script>
<script src="js/classie.js" type="text/javascript"></script>
<script src="https://code.jquery.com/jquery-1.11.2.min.js"></script>
<meta charset="UTF-8">
<!--[if IE]>
<meta content="IE=edge" http-equiv="X-UA-Compatible">
<![endif]-->
<meta content="width=device-width, initial-scale=1.0" name="viewport">
<meta content="Asciidoctor 2.0.21" name="generator">
<title>Taiga: Setup development environment</title>
<style>/*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
/* Uncomment the following line when using as a custom stylesheet */
/* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
html{font-family:sans-serif;-webkit-text-size-adjust:100%}
a{background:none}
a:focus{outline:thin dotted}
a:active,a:hover{outline:0}
h1{font-size:2em;margin:.67em 0}
b,strong{font-weight:bold}
abbr{font-size:.9em}
abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
dfn{font-style:italic}
hr{height:0}
mark{background:#ff0;color:#000}
code,kbd,pre,samp{font-family:monospace;font-size:1em}
pre{white-space:pre-wrap}
q{quotes:"\201C" "\201D" "\2018" "\2019"}
small{font-size:80%}
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
sup{top:-.5em}
sub{bottom:-.25em}
img{border:0}
svg:not(:root){overflow:hidden}
figure{margin:0}
audio,video{display:inline-block}
audio:not([controls]){display:none;height:0}
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
legend{border:0;padding:0}
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
button,input{line-height:normal}
button,select{text-transform:none}
button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
button[disabled],html input[disabled]{cursor:default}
input[type=checkbox],input[type=radio]{padding:0}
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
textarea{overflow:auto;vertical-align:top}
table{border-collapse:collapse;border-spacing:0}
*,::before,::after{box-sizing:border-box}
html,body{font-size:100%}
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
a:hover{cursor:pointer}
img,object,embed{max-width:100%;height:auto}
object,embed{height:100%}
img{-ms-interpolation-mode:bicubic}
.left{float:left!important}
.right{float:right!important}
.text-left{text-align:left!important}
.text-right{text-align:right!important}
.text-center{text-align:center!important}
.text-justify{text-align:justify!important}
.hide{display:none}
img,object,svg{display:inline-block;vertical-align:middle}
textarea{height:auto;min-height:50px}
select{width:100%}
.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
a{color:#2156a5;text-decoration:underline;line-height:inherit}
a:hover,a:focus{color:#1d4b8f}
a img{border:0}
p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
p aside{font-size:.875em;line-height:1.35;font-style:italic}
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
h1{font-size:2.125em}
h2{font-size:1.6875em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
h4,h5{font-size:1.125em}
h6{font-size:1em}
hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
em,i{font-style:italic;line-height:inherit}
strong,b{font-weight:bold;line-height:inherit}
small{font-size:60%;line-height:inherit}
code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
ul,ol{margin-left:1.5em}
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
ul.circle{list-style-type:circle}
ul.disc{list-style-type:disc}
ul.square{list-style-type:square}
ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
dl dt{margin-bottom:.3125em;font-weight:bold}
dl dd{margin-bottom:1.25em}
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
h1{font-size:2.75em}
h2{font-size:2.3125em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
h4{font-size:1.4375em}}
table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
table thead,table tfoot{background:#f7f8f7}
table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
table tr.even,table tr.alt{background:#f8f8f7}
table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
.center{margin-left:auto;margin-right:auto}
.stretch{width:100%}
.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
.clearfix::after,.float-group::after{clear:both}
:not(pre).nobreak{word-wrap:normal}
:not(pre).nowrap{white-space:nowrap}
:not(pre).pre-wrap{white-space:pre-wrap}
:not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
pre>code{display:block}
pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
em em{font-style:normal}
strong strong{font-weight:400}
.keyseq{color:rgba(51,51,51,.8)}
kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
.keyseq kbd:first-child{margin-left:0}
.keyseq kbd:last-child{margin-right:0}
.menuseq,.menuref{color:#000}
.menuseq b:not(.caret),.menuref{font-weight:inherit}
.menuseq{word-spacing:-.02em}
.menuseq b.caret{font-size:1.25em;line-height:.8}
.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
b.button::before{content:"[";padding:0 3px 0 2px}
b.button::after{content:"]";padding:0 2px 0 3px}
p a>code:hover{color:rgba(0,0,0,.9)}
#header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
#content{margin-top:1.25em}
#content::before{content:none}
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
#header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px}
#header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
#header .details span:first-child{margin-left:-.125em}
#header .details span.email a{color:rgba(0,0,0,.85)}
#header .details br{display:none}
#header .details br+span::before{content:"\00a0\2013\00a0"}
#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
#header .details br+span#revremark::before{content:"\00a0|\00a0"}
#header #revnumber{text-transform:capitalize}
#header #revnumber::after{content:"\00a0"}
#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
#toc>ul{margin-left:.125em}
#toc ul.sectlevel0>li>a{font-style:italic}
#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
#toc li{line-height:1.3334;margin-top:.3334em}
#toc a{text-decoration:none}
#toc a:active{text-decoration:underline}
#toctitle{color:#7a2518;font-size:1.2em}
@media screen and (min-width:768px){#toctitle{font-size:1.375em}
body.toc2{padding-left:15em;padding-right:0}
body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
#toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
#toc.toc2>ul{font-size:.9em;margin-bottom:0}
#toc.toc2 ul ul{margin-left:0;padding-left:1em}
#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
body.toc2.toc-right{padding-left:0;padding-right:15em}
body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
#toc.toc2{width:20em}
#toc.toc2 #toctitle{font-size:1.375em}
#toc.toc2>ul{font-size:.95em}
#toc.toc2 ul ul{padding-left:1.25em}
body.toc2.toc-right{padding-left:0;padding-right:20em}}
#content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
#content #toc>:first-child{margin-top:0}
#content #toc>:last-child{margin-bottom:0}
#footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
#footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
#content{margin-bottom:.625em}
.sect1{padding-bottom:.625em}
@media screen and (min-width:768px){#content{margin-bottom:1.25em}
.sect1{padding-bottom:1.25em}}
.sect1:last-child{padding-bottom:0}
.sect1+.sect1{border-top:1px solid #e7e7e9}
#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
#content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
details{margin-left:1.25rem}
details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
details>summary::-webkit-details-marker{display:none}
details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
.paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
.admonitionblock>table td.icon{text-align:center;width:80px}
.admonitionblock>table td.icon img{max-width:none}
.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
.exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
.sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
.exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
.exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
.literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
.literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
.literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
.listingblock>.content{position:relative}
.listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
.listingblock:hover code[data-lang]::before{display:block}
.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
.listingblock pre.highlightjs{padding:0}
.listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
.listingblock pre.prettyprint{border-width:0}
.prettyprint{background:#f7f7f8}
pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
pre.prettyprint li code[data-lang]::before{opacity:1}
pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
table.linenotable td.code{padding-left:.75em}
table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
pre.pygments span.linenos{display:inline-block;margin-right:.75em}
.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
.quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
.quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
.quoteblock blockquote{margin:0;padding:0;border:0}
.quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
.verseblock{margin:0 1em 1.25em}
.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
.verseblock pre strong{font-weight:400}
.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
.quoteblock .attribution br,.verseblock .attribution br{display:none}
.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
.quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
.quoteblock.abstract{margin:0 1em 1.25em;display:block}
.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
.quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
.quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
p.tableblock:last-child{margin-bottom:0}
td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
td.tableblock>.content>:last-child{margin-bottom:-1.25em}
table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
table.grid-all>*>tr>*{border-width:1px}
table.grid-cols>*>tr>*{border-width:0 1px}
table.grid-rows>*>tr>*{border-width:1px 0}
table.frame-all{border-width:1px}
table.frame-ends{border-width:1px 0}
table.frame-sides{border-width:0 1px}
table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
th.halign-left,td.halign-left{text-align:left}
th.halign-right,td.halign-right{text-align:right}
th.halign-center,td.halign-center{text-align:center}
th.valign-top,td.valign-top{vertical-align:top}
th.valign-bottom,td.valign-bottom{vertical-align:bottom}
th.valign-middle,td.valign-middle{vertical-align:middle}
table thead th,table tfoot th{font-weight:bold}
tbody tr th{background:#f7f8f7}
tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
p.tableblock>code:only-child{background:none;padding:0}
p.tableblock{font-size:1em}
ol{margin-left:1.75em}
ul li ol{margin-left:1.5em}
dl dd{margin-left:1.125em}
dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
ul.unstyled,ol.unstyled{margin-left:0}
li>p:empty:only-child::before{content:"";display:inline-block}
ul.checklist>li>p:first-child{margin-left:-1em}
ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
ul.inline>li{margin-left:1.25em}
.unstyled dl dt{font-weight:400;font-style:normal}
ol.arabic{list-style-type:decimal}
ol.decimal{list-style-type:decimal-leading-zero}
ol.loweralpha{list-style-type:lower-alpha}
ol.upperalpha{list-style-type:upper-alpha}
ol.lowerroman{list-style-type:lower-roman}
ol.upperroman{list-style-type:upper-roman}
ol.lowergreek{list-style-type:lower-greek}
.hdlist>table,.colist>table{border:0;background:none}
.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
td.hdlist1{font-weight:bold;padding-bottom:1.25em}
td.hdlist2{word-wrap:anywhere}
.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
.colist td:not([class]):first-child img{max-width:none}
.colist td:not([class]):last-child{padding:.25em 0}
.thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
.imageblock.left{margin:.25em .625em 1.25em 0}
.imageblock.right{margin:.25em 0 1.25em .625em}
.imageblock>.title{margin-bottom:0}
.imageblock.thumb,.imageblock.th{border-width:6px}
.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
.image.left{margin-right:.625em}
.image.right{margin-left:.625em}
a.image{text-decoration:none;display:inline-block}
a.image object{pointer-events:none}
sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
sup.footnote a,sup.footnoteref a{text-decoration:none}
sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline}
#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
#footnotes .footnote:last-of-type{margin-bottom:0}
#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
div.unbreakable{page-break-inside:avoid}
.big{font-size:larger}
.small{font-size:smaller}
.underline{text-decoration:underline}
.overline{text-decoration:overline}
.line-through{text-decoration:line-through}
.aqua{color:#00bfbf}
.aqua-background{background:#00fafa}
.black{color:#000}
.black-background{background:#000}
.blue{color:#0000bf}
.blue-background{background:#0000fa}
.fuchsia{color:#bf00bf}
.fuchsia-background{background:#fa00fa}
.gray{color:#606060}
.gray-background{background:#7d7d7d}
.green{color:#006000}
.green-background{background:#007d00}
.lime{color:#00bf00}
.lime-background{background:#00fa00}
.maroon{color:#600000}
.maroon-background{background:#7d0000}
.navy{color:#000060}
.navy-background{background:#00007d}
.olive{color:#606000}
.olive-background{background:#7d7d00}
.purple{color:#600060}
.purple-background{background:#7d007d}
.red{color:#bf0000}
.red-background{background:#fa0000}
.silver{color:#909090}
.silver-background{background:#bcbcbc}
.teal{color:#006060}
.teal-background{background:#007d7d}
.white{color:#bfbfbf}
.white-background{background:#fafafa}
.yellow{color:#bfbf00}
.yellow-background{background:#fafa00}
span.icon>.fa{cursor:default}
a span.icon>.fa{cursor:inherit}
.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
.conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
.conum[data-value] *{color:#fff!important}
.conum[data-value]+b{display:none}
.conum[data-value]::after{content:attr(data-value)}
pre .conum[data-value]{position:relative;top:-.125em}
b.conum *{color:inherit!important}
.conum:not([data-value]):empty{display:none}
dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
p{margin-bottom:1.25rem}
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
.print-only{display:none!important}
@page{margin:1.25cm .75cm}
@media print{*{box-shadow:none!important;text-shadow:none!important}
html{font-size:80%}
a{color:inherit!important;text-decoration:underline!important}
a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
abbr[title]{border-bottom:1px dotted}
abbr[title]::after{content:" (" attr(title) ")"}
pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
thead{display:table-header-group}
svg{max-width:100%}
p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
#header,#content,#footnotes,#footer{max-width:none}
#toc,.sidebarblock,.exampleblock>.content{background:none!important}
#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
body.book #header{text-align:center}
body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
body.book #header .details{border:0!important;display:block;padding:0!important}
body.book #header .details span:first-child{margin-left:0!important}
body.book #header .details br{display:block}
body.book #header .details br+span::before{content:none!important}
body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
.listingblock code[data-lang]::before{display:block}
#footer{padding:0 .9375em}
.hide-on-print{display:none!important}
.print-only{display:block!important}
.hide-for-print{display:none!important}
.show-for-print{display:inherit!important}}
@media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
.sect1{padding:0!important}
.sect1+.sect1{border:0}
#footer{background:none}
#footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}</style>
<style>pre.pygments .hll { background-color: #ffffcc }
pre.pygments { background: #f0f0f0; }
pre.pygments .tok-c { color: #60a0b0; font-style: italic } /* Comment */
pre.pygments .tok-err { border: 1px solid #FF0000 } /* Error */
pre.pygments .tok-k { color: #007020; font-weight: bold } /* Keyword */
pre.pygments .tok-o { color: #666666 } /* Operator */
pre.pygments .tok-ch { color: #60a0b0; font-style: italic } /* Comment.Hashbang */
pre.pygments .tok-cm { color: #60a0b0; font-style: italic } /* Comment.Multiline */
pre.pygments .tok-cp { color: #007020 } /* Comment.Preproc */
pre.pygments .tok-cpf { color: #60a0b0; font-style: italic } /* Comment.PreprocFile */
pre.pygments .tok-c1 { color: #60a0b0; font-style: italic } /* Comment.Single */
pre.pygments .tok-cs { color: #60a0b0; background-color: #fff0f0 } /* Comment.Special */
pre.pygments .tok-gd { color: #A00000 } /* Generic.Deleted */
pre.pygments .tok-ge { font-style: italic } /* Generic.Emph */
pre.pygments .tok-gr { color: #FF0000 } /* Generic.Error */
pre.pygments .tok-gh { color: #000080; font-weight: bold } /* Generic.Heading */
pre.pygments .tok-gi { color: #00A000 } /* Generic.Inserted */
pre.pygments .tok-go { color: #888888 } /* Generic.Output */
pre.pygments .tok-gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
pre.pygments .tok-gs { font-weight: bold } /* Generic.Strong */
pre.pygments .tok-gu { color: #800080; font-weight: bold } /* Generic.Subheading */
pre.pygments .tok-gt { color: #0044DD } /* Generic.Traceback */
pre.pygments .tok-kc { color: #007020; font-weight: bold } /* Keyword.Constant */
pre.pygments .tok-kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
pre.pygments .tok-kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
pre.pygments .tok-kp { color: #007020 } /* Keyword.Pseudo */
pre.pygments .tok-kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
pre.pygments .tok-kt { color: #902000 } /* Keyword.Type */
pre.pygments .tok-m { color: #40a070 } /* Literal.Number */
pre.pygments .tok-s { color: #4070a0 } /* Literal.String */
pre.pygments .tok-na { color: #4070a0 } /* Name.Attribute */
pre.pygments .tok-nb { color: #007020 } /* Name.Builtin */
pre.pygments .tok-nc { color: #0e84b5; font-weight: bold } /* Name.Class */
pre.pygments .tok-no { color: #60add5 } /* Name.Constant */
pre.pygments .tok-nd { color: #555555; font-weight: bold } /* Name.Decorator */
pre.pygments .tok-ni { color: #d55537; font-weight: bold } /* Name.Entity */
pre.pygments .tok-ne { color: #007020 } /* Name.Exception */
pre.pygments .tok-nf { color: #06287e } /* Name.Function */
pre.pygments .tok-nl { color: #002070; font-weight: bold } /* Name.Label */
pre.pygments .tok-nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
pre.pygments .tok-nt { color: #062873; font-weight: bold } /* Name.Tag */
pre.pygments .tok-nv { color: #bb60d5 } /* Name.Variable */
pre.pygments .tok-ow { color: #007020; font-weight: bold } /* Operator.Word */
pre.pygments .tok-w { color: #bbbbbb } /* Text.Whitespace */
pre.pygments .tok-mb { color: #40a070 } /* Literal.Number.Bin */
pre.pygments .tok-mf { color: #40a070 } /* Literal.Number.Float */
pre.pygments .tok-mh { color: #40a070 } /* Literal.Number.Hex */
pre.pygments .tok-mi { color: #40a070 } /* Literal.Number.Integer */
pre.pygments .tok-mo { color: #40a070 } /* Literal.Number.Oct */
pre.pygments .tok-sa { color: #4070a0 } /* Literal.String.Affix */
pre.pygments .tok-sb { color: #4070a0 } /* Literal.String.Backtick */
pre.pygments .tok-sc { color: #4070a0 } /* Literal.String.Char */
pre.pygments .tok-dl { color: #4070a0 } /* Literal.String.Delimiter */
pre.pygments .tok-sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
pre.pygments .tok-s2 { color: #4070a0 } /* Literal.String.Double */
pre.pygments .tok-se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
pre.pygments .tok-sh { color: #4070a0 } /* Literal.String.Heredoc */
pre.pygments .tok-si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
pre.pygments .tok-sx { color: #c65d09 } /* Literal.String.Other */
pre.pygments .tok-sr { color: #235388 } /* Literal.String.Regex */
pre.pygments .tok-s1 { color: #4070a0 } /* Literal.String.Single */
pre.pygments .tok-ss { color: #517918 } /* Literal.String.Symbol */
pre.pygments .tok-bp { color: #007020 } /* Name.Builtin.Pseudo */
pre.pygments .tok-fm { color: #06287e } /* Name.Function.Magic */
pre.pygments .tok-vc { color: #bb60d5 } /* Name.Variable.Class */
pre.pygments .tok-vg { color: #bb60d5 } /* Name.Variable.Global */
pre.pygments .tok-vi { color: #bb60d5 } /* Name.Variable.Instance */
pre.pygments .tok-vm { color: #bb60d5 } /* Name.Variable.Magic */
pre.pygments .tok-il { color: #40a070 } /* Literal.Number.Integer.Long */</style>
</head>
<link href="css/menu.css" rel="stylesheet">
<link href="css/icons.css" rel="stylesheet">
<link href="css/main.css" rel="stylesheet">
<link href="css/styles.css" rel="stylesheet">
<body class="article toc2 toc-left"></body>
</html>
<div class="container">
<a class="menu-trigger" id="trigger"></a>
<div class="mp-pusher" id="mp-pusher">
<div class="toc2" id="toc">
<div class="mp-level">
<div id="toctitle">Table of Contents</div>
<ul class="sectlevel1">
<li>
<a href="#_introduction">1. Introduction</a>
</li>
<li>
<a href="#_before_starting">2. Before starting</a>
</li>
<li>
<a href="#_backend_environment">3. Backend environment</a>
<div class="mp-level">
<a class="mp-back" href="#">back</a>
<ul class="sectlevel2">
<li>
<a href="#_install_dependencies">3.1. Install dependencies</a>
</li>
<li>
<a href="#_setup_a_database">3.2. Setup a database</a>
</li>
<li>
<a href="#_setup_python_environment">3.3. Setup python environment</a>
</li>
<li>
<a href="#_run">3.4. Run</a>
</li>
<li>
<a href="#_async_tasks_optional">3.5. Async tasks (Optional)</a>
</li>
<li>
<a href="#_debian_installation_notes">3.6. Debian installation notes</a>
</li>
</ul>
</div>
</li>
<li>
<a href="#_frontend_environment">4. Frontend environment</a>
<div class="mp-level">
<a class="mp-back" href="#">back</a>
<ul class="sectlevel2">
<li>
<a href="#_install_dependencies_2">4.1. Install dependencies</a>
</li>
<li>
<a href="#_debian_installation_notes_2">4.2. Debian installation notes</a>
</li>
<li>
<a href="#_final_steps">4.3. Final steps</a>
</li>
</ul>
</div>
</li>
<li>
<a href="#_events_installation">5. Events installation</a>
</li>
</ul>
</div>
</div>
<div class="scroller">
<div id="header">
<h1>Taiga: Setup development environment</h1>
</div>
<div id="content">
<div class="sect1">
<h2 id="_introduction">1. Introduction</h2>
<div class="sectionbody">
<div class="paragraph">
<p>This documentation explains how to setup the Taiga development environment.</p>
</div>
<div class="paragraph">
<p>The Taiga platform consists of three main components:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><strong>taiga-back</strong> (backend/api)</p>
</li>
<li>
<p><strong>taiga-front</strong> (frontend)</p>
</li>
<li>
<p><strong>taiga-events</strong> (websockets gateway) (optional)</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>And each one has its own dependencies, at compile time and runtime.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_before_starting">2. Before starting</h2>
<div class="sectionbody">
<div class="paragraph">
<p>This tutorial assumes that you are using a clean, recently updated, <strong>Ubuntu 20.04</strong> image.
Notes for Debian installations are included at the end of the appropriate sections.</p>
</div>
<div class="paragraph">
<p><strong>Taiga installation must be done with a "normal" user, never with root.</strong></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_backend_environment">3. Backend environment</h2>
<div class="sectionbody">
<div class="paragraph">
<p>This section helps with the download and configuration of the backend (api) Taiga service.</p>
</div>
<div class="sect2">
<h3 id="_install_dependencies">3.1. Install dependencies</h3>
<div class="paragraph">
<p>The backend is written mainly in python (&gt;= 3.8, &lt; 3.12) but for some third party libraries we need to install a
C compiler and development headers.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>sudo apt-get install -y build-essential binutils-doc autoconf flex bison libjpeg-dev&#x000A;sudo apt-get install -y libfreetype6-dev zlib1g-dev libzmq3-dev libgdbm-dev libncurses5-dev&#x000A;sudo apt-get install -y automake libtool libffi-dev libssl-dev curl git tmux gettext</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_setup_a_database">3.2. Setup a database</h3>
<div class="paragraph">
<p><strong>taiga-back</strong> also requires postgresql (&gt;= 9.4, &lt; 14) as a database</p>
</div>
<div class="paragraph">
<p>Install postgresql:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>sudo apt-get install -y postgresql postgresql-contrib&#x000A;sudo apt-get install -y postgresql-doc postgresql-server-dev-all</code></pre>
</div>
</div>
<div class="paragraph">
<p>And setup the initial user, database, and permissions:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>sudo -u postgres psql -c <span class="tok-s2">&quot;CREATE ROLE taiga LOGIN PASSWORD &#39;changeme&#39;;&quot;</span>&#x000A;sudo -u postgres createdb taiga -O taiga --encoding<span class="tok-o">=</span><span class="tok-s1">&#39;utf-8&#39;</span> --locale<span class="tok-o">=</span>en_US.utf8 --template<span class="tok-o">=</span>template0&#x000A;<span class="tok-nb">echo</span> <span class="tok-s1">&#39;local all taiga peer&#39;</span> <span class="tok-p">|</span> sudo -u postgres tee -a <span class="tok-k">$(</span>sudo -u postgres psql -t -P <span class="tok-nv">format</span><span class="tok-o">=</span>unaligned -c <span class="tok-s1">&#39;show hba_file&#39;</span><span class="tok-k">)</span> &gt; /dev/null&#x000A;sudo service postgresql reload</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_setup_python_environment">3.3. Setup python environment</h3>
<div class="paragraph">
<p>To run <strong>taiga-back</strong> you should have python (&gt;=3.8, &lt; 3.12) installed along with some other third party
libraries. As a first step, start installing python:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>sudo apt-get install -y python3 python3-pip python3-virtualenv python-dev python3-dev python-pip python-virtualenv&#x000A;sudo apt-get install -y libxml2-dev libxslt-dev</code></pre>
</div>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<div class="title"></div>
</td>
<td class="content">
Between November 2018 and May 2020,
taiga-back relied on <a href="https://pypi.org/project/pipenv/">pipenv</a> to manage dependencies and its virtualenv.
Currently, taiga-back uses <code>pip</code> and <a href="https://pypi.org/project/pip-tools/">pip-tools</a> to manage dependecies
and <code>venv</code> to create its virtualenv.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>The next step is to download the code from GitHub and install its dependencies:</p>
</div>
<div class="listingblock">
<div class="title">Download the code</div>
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span><span class="tok-nb">cd</span> ~&#x000A;git clone https://github.com/taigaio/taiga-back.git taiga-back&#x000A;<span class="tok-nb">cd</span> taiga-back&#x000A;git checkout main</code></pre>
</div>
</div>
<div class="listingblock">
<div class="title">Create a new virtualenv, activate it and install taiga-back base requirements</div>
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>python -m venv .venv&#x000A;<span class="tok-nb">source</span> .venv/bin/activate&#x000A;python -m pip install --upgrade pip setuptools wheel&#x000A;python -m pip install --upgrade pip-tools</code></pre>
</div>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<div class="title"></div>
</td>
<td class="content">
We are using the <code>venv</code> module, included in the standard library, to manage the taiga-back virtual environmnent
but you can choose other ways to manage the virtual environment
like <a href="https://pypi.org/project/virtualenvwrapper/">virtualenvwrapper</a>
or <a href="https://pypi.org/project/pew/">pew</a>.
</td>
</tr>
</table>
</div>
<div class="listingblock">
<div class="title">Install dependencies</div>
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>python -m pip install -r requirements.txt -r requirements-devel.txt</code></pre>
</div>
</div>
<div class="paragraph">
<div class="title">Adjust Django Configuration</div>
<p>You can tune your own environment configuration by editing a <code>settings/config.py</code>
configuration file to overwrite any setting in <code>settings/common.py</code>.</p>
</div>
<div class="paragraph">
<p>For a basic configuration that works with these instructions, simply copy
<code>settings/config.py.prod.example</code> to <code>settings/config.py</code> (but remember to edit your postgresql password, to match what you picked for the
<code>CREATE ROLE taiga LOGIN PASSWORD</code> command above).</p>
</div>
<div class="paragraph">
<p>Otherwise, just put this in your own <code>~/taiga-back/settings/config.py</code></p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="python"><span></span><span class="tok-kn">from</span> <span class="tok-nn">.common</span> <span class="tok-kn">import</span> <span class="tok-o">*</span>&#x000A;&#x000A;<span class="tok-c1"># YOUR OWN CONFIGURATION HERE</span></code></pre>
</div>
</div>
<div class="listingblock">
<div class="title">Populate the database with initial basic data</div>
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>python manage.py migrate --noinput&#x000A;python manage.py loaddata initial_user&#x000A;python manage.py loaddata initial_project_templates&#x000A;python manage.py compilemessages&#x000A;python manage.py collectstatic --noinput&#x000A;python manage.py sample_data</code></pre>
</div>
</div>
<div class="paragraph">
<p>This creates a new user <strong>admin</strong> with password <strong>123123</strong> and some sample data.</p>
</div>
</div>
<div class="sect2">
<h3 id="_run">3.4. Run</h3>
<div class="paragraph">
<p>To run the development environment you can run:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>python manage.py runserver</code></pre>
</div>
</div>
<div class="paragraph">
<p>Then you should be able to see a json represention of the list of endpoints at the url <a class="bare" href="http://localhost:8000/api/v1/">http://localhost:8000/api/v1/</a></p>
</div>
</div>
<div class="sect2">
<h3 id="_async_tasks_optional">3.5. Async tasks (Optional)</h3>
<div class="paragraph">
<p>The default behavior in Taiga is to do all tasks synchronously, but some of them
can be completely asynchronous (for example webhooks or import/export). To do
this, you have to configure and install the celery service requirements.</p>
</div>
<div class="paragraph">
<p>Install <code>rabbitmq-server</code> and <code>redis-server</code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>sudo apt-get install -y rabbitmq-server redis-server</code></pre>
</div>
</div>
<div class="paragraph">
<p>To run celery with Taiga you have to include the following line in your config.py:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="python"><span></span><span class="tok-n">CELERY_ENABLED</span> <span class="tok-o">=</span> <span class="tok-kc">True</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>You can configure other broker or results backends as needed. If you need more
info about configuration you can check the celery documentation web page:
<a class="bare" href="http://docs.celeryproject.org/en/latest/index.html">http://docs.celeryproject.org/en/latest/index.html</a></p>
</div>
<div class="paragraph">
<p>Once you have configured celery on Taiga, you have to run celery to process the
tasks. You can run celery with:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>python -m celery -A taiga worker -l info -E</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_debian_installation_notes">3.6. Debian installation notes</h3>
<div class="paragraph">
<p>Debian stable (Jessie) provides all needed requirements, but old-stable (Wheezy) does not.</p>
</div>
<div class="paragraph">
<p>The latest Python available from Wheezy&#8217;s apt repositories is only 3.1 and insufficient for taiga-back.
You must build Python (&gt;= 3.8, &lt; 3.12) from source (see <a class="bare" href="https://www.python.org/downloads/source/">https://www.python.org/downloads/source/</a> for links).
When building from source, if the bz2 development libraries are not already present on your system, then you must first:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>sudo apt-get install libbz2-dev</code></pre>
</div>
</div>
<div class="paragraph">
<p>Or else Python will build without the bz2 module necessary for some pip installed requirements.</p>
</div>
<div class="paragraph">
<p>The latest Postgresql available for Wheezy is 9.1, but a fully Wheezy-compatible 9.4 build is available from
the official Postgresql apt repositories, however:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span><span class="tok-nb">echo</span> <span class="tok-s2">&quot;deb http://apt.postgresql.org/pub/repos/apt/ wheezy-pgdg main&quot;</span> <span class="tok-p">|</span> sudo tee -a /etc/apt/sources.list&#x000A;sudo apt-get update</code></pre>
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_frontend_environment">4. Frontend environment</h2>
<div class="sectionbody">
<div class="paragraph">
<p>This section helps you install the frontend application</p>
</div>
<div class="sect2">
<h3 id="_install_dependencies_2">4.1. Install dependencies</h3>
<div class="paragraph">
<p>The frontend application runs entirely in a browser, and thus must be deployed as javascript, css and html.
In the case of <strong>taiga-front</strong> we have used other languages. Because of this, you will need to install some
additional dependencies that compile <strong>taiga-front</strong> code into something the browser can understand.</p>
</div>
<div class="sect3">
<h4 id="_nodejs_and_friends">4.1.1. NodeJS and friends</h4>
<div class="paragraph">
<p>NodeJS is used to execute <strong>gulp</strong>, a task execution tool used mainly for executing deployment and compilation tasks.</p>
</div>
<div class="listingblock">
<div class="title">Install nodejs (specific version 16)</div>
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>curl -sL https://deb.nodesource.com/setup_16.x <span class="tok-p">|</span> sudo -E bash -&#x000A;sudo apt-get install -y nodejs npm</code></pre>
</div>
</div>
<div class="listingblock">
<div class="title">Make sure your bash responds to the node command to have a smooth installation of gulp</div>
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>node</code></pre>
</div>
</div>
<div class="paragraph">
<p>If you get a "Command not found" error, then run</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>sudo update-alternatives --install /usr/bin/node nodejs /usr/bin/nodejs <span class="tok-m">100</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>(If you&#8217;re on Debian, see the Debian-specific installation notes below.)</p>
</div>
<div class="listingblock">
<div class="title">Install <strong>gulp</strong> using the recently installed npm</div>
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>sudo npm install -g gulp</code></pre>
</div>
</div>
<div class="listingblock">
<div class="title">Download the code</div>
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span><span class="tok-nb">cd</span> ~&#x000A;git clone https://github.com/taigaio/taiga-front.git taiga-front&#x000A;<span class="tok-nb">cd</span> taiga-front&#x000A;git checkout stable</code></pre>
</div>
</div>
<div class="listingblock">
<div class="title">Install all dependencies needed to run gulp and compile taiga-front</div>
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>npm install</code></pre>
</div>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_debian_installation_notes_2">4.2. Debian installation notes</h3>
<div class="paragraph">
<p>While Debian stable (Jessie), provides a nodejs package out of the box, old-stable (Wheezy) does not.
You can access one via the wheezy-backports apt repository, however, which can be added to your system as follows:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span><span class="tok-nb">echo</span> <span class="tok-s2">&quot;deb http://ftp.us.debian.org/debian wheezy-backports main&quot;</span> <span class="tok-p">|</span> sudo tee -a /etc/apt/sources.list</code></pre>
</div>
</div>
<div class="paragraph">
<p>Then, after a:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>sudo apt-get update</code></pre>
</div>
</div>
<div class="paragraph">
<p>You can:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>sudo apt-get install nodejs</code></pre>
</div>
</div>
<div class="paragraph">
<p>Note that Debian installs the executable as nodejs not node, so you will need to provide this alias by issuing the following command:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>sudo update-alternatives --install /usr/bin/node nodejs /usr/bin/nodejs <span class="tok-m">100</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>Stable (Jessie) also provides an npm package, but npm is not available for old-stable (Wheezy), not even from wheezy-backports.
Thus, you will need to install it manually via:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>curl https://www.npmjs.com/install.sh <span class="tok-p">|</span> sudo sh</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_final_steps">4.3. Final steps</h3>
<div class="paragraph">
<p>Having installed all the dependencies, all you have left to do is to run the code itself.</p>
</div>
<div class="listingblock">
<div class="title">Run</div>
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span><span class="tok-nb">cd</span> ~/taiga-front&#x000A;npm start</code></pre>
</div>
</div>
<div class="paragraph">
<p>And now, you can configure it copying the
<code>dist/conf.example.json</code> to <code>dist/conf.json</code>
and editing it.</p>
</div>
<div class="listingblock">
<div class="title">Copy and edit initial configuration on ~/taiga-front/dist/conf.json</div>
<div class="content">
<pre class="pygments highlight"><code data-lang="json"><span></span><span class="tok-p">{</span>&#x000A; <span class="tok-nt">&quot;api&quot;</span><span class="tok-p">:</span> <span class="tok-s2">&quot;http://localhost:8000/api/v1/&quot;</span><span class="tok-p">,</span>&#x000A; <span class="tok-nt">&quot;eventsUrl&quot;</span><span class="tok-p">:</span> <span class="tok-kc">null</span><span class="tok-p">,</span>&#x000A; <span class="tok-nt">&quot;eventsMaxMissedHeartbeats&quot;</span><span class="tok-p">:</span> <span class="tok-mi">5</span><span class="tok-p">,</span>&#x000A; <span class="tok-nt">&quot;eventsHeartbeatIntervalTime&quot;</span><span class="tok-p">:</span> <span class="tok-mi">60000</span><span class="tok-p">,</span>&#x000A; <span class="tok-nt">&quot;debug&quot;</span><span class="tok-p">:</span> <span class="tok-kc">true</span><span class="tok-p">,</span>&#x000A; <span class="tok-nt">&quot;debugInfo&quot;</span><span class="tok-p">:</span> <span class="tok-kc">false</span><span class="tok-p">,</span>&#x000A; <span class="tok-nt">&quot;defaultLanguage&quot;</span><span class="tok-p">:</span> <span class="tok-s2">&quot;en&quot;</span><span class="tok-p">,</span>&#x000A; <span class="tok-nt">&quot;themes&quot;</span><span class="tok-p">:</span> <span class="tok-p">[</span><span class="tok-s2">&quot;taiga&quot;</span><span class="tok-p">],</span>&#x000A; <span class="tok-nt">&quot;defaultTheme&quot;</span><span class="tok-p">:</span> <span class="tok-s2">&quot;taiga&quot;</span><span class="tok-p">,</span>&#x000A; <span class="tok-nt">&quot;publicRegisterEnabled&quot;</span><span class="tok-p">:</span> <span class="tok-kc">true</span><span class="tok-p">,</span>&#x000A; <span class="tok-nt">&quot;feedbackEnabled&quot;</span><span class="tok-p">:</span> <span class="tok-kc">true</span><span class="tok-p">,</span>&#x000A; <span class="tok-nt">&quot;privacyPolicyUrl&quot;</span><span class="tok-p">:</span> <span class="tok-kc">null</span><span class="tok-p">,</span>&#x000A; <span class="tok-nt">&quot;termsOfServiceUrl&quot;</span><span class="tok-p">:</span> <span class="tok-kc">null</span><span class="tok-p">,</span>&#x000A; <span class="tok-nt">&quot;maxUploadFileSize&quot;</span><span class="tok-p">:</span> <span class="tok-kc">null</span><span class="tok-p">,</span>&#x000A; <span class="tok-nt">&quot;contribPlugins&quot;</span><span class="tok-p">:</span> <span class="tok-p">[]</span>&#x000A;&#x000A;<span class="tok-p">}</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>Now, you can access <a class="bare" href="http://localhost:9001">http://localhost:9001</a> for access to taiga-front.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<div class="title"></div>
</td>
<td class="content">
If you have npm errors when executing gulp delete the tmp files and install the
dependencies again.
</td>
</tr>
</table>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>rm -rf ~/.npm<span class="tok-p">;</span> rm -rf node_modules&#x000A;npm install&#x000A;gulp</code></pre>
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_events_installation">5. Events installation</h2>
<div class="sectionbody">
<div class="paragraph">
<p><strong>This step is completelly optional and can be skipped</strong></p>
</div>
<div class="paragraph">
<p>Taiga events needs rabbitmq (the message broker) to be installed</p>
</div>
<div class="listingblock">
<div class="title">Installing rabbitmq</div>
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>sudo apt-get install rabbitmq-server</code></pre>
</div>
</div>
<div class="listingblock">
<div class="title">Creating a rabbitmquser named <code>taiga</code> and virtualhost for rabbitmq</div>
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>sudo rabbitmqctl add_user rabbitmquser rabbitmqpassword&#x000A;sudo rabbitmqctl add_vhost taiga&#x000A;sudo rabbitmqctl set_permissions -p taiga rabbitmquser <span class="tok-s2">&quot;.*&quot;</span> <span class="tok-s2">&quot;.*&quot;</span> <span class="tok-s2">&quot;.*&quot;</span></code></pre>
</div>
</div>
<div class="listingblock">
<div class="title">Update your taiga-back settings to include the following lines in your config.py:</div>
<div class="content">
<pre class="pygments highlight"><code data-lang="python"><span></span><span class="tok-n">EVENTS_PUSH_BACKEND</span> <span class="tok-o">=</span> <span class="tok-s2">&quot;taiga.events.backends.rabbitmq.EventsPushBackend&quot;</span>&#x000A;<span class="tok-n">EVENTS_PUSH_BACKEND_OPTIONS</span> <span class="tok-o">=</span> <span class="tok-p">{</span><span class="tok-s2">&quot;url&quot;</span><span class="tok-p">:</span> <span class="tok-s2">&quot;amqp://rabbitmquser:rabbitmqpassword@rabbitmqhost:5672/taiga&quot;</span><span class="tok-p">}</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>The next step is downloading the code from GitHub and installing the dependencies:</p>
</div>
<div class="listingblock">
<div class="title">Download the code</div>
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span><span class="tok-nb">cd</span> ~&#x000A;git clone https://github.com/taigaio/taiga-events.git taiga-events&#x000A;<span class="tok-nb">cd</span> taiga-events</code></pre>
</div>
</div>
<div class="listingblock">
<div class="title">Install all the javascript dependencies needed</div>
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>npm install&#x000A;sudo npm install -g coffee-script</code></pre>
</div>
</div>
<div class="listingblock">
<div class="title">Copy config.example.json to config.json and edit it to update the values for your rabbitmq uri and secret key.</div>
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>cp config.example.json config.json</code></pre>
</div>
</div>
<div class="listingblock">
<div class="title">Your config.json should look something like:</div>
<div class="content">
<pre class="pygments highlight"><code data-lang="json"><span></span><span class="tok-p">{</span>&#x000A; <span class="tok-nt">&quot;url&quot;</span><span class="tok-p">:</span> <span class="tok-s2">&quot;amqp://rabbitmquser:rabbitmqpassword@rabbitmqhost:5672/taiga&quot;</span><span class="tok-p">,</span>&#x000A; <span class="tok-nt">&quot;secret&quot;</span><span class="tok-p">:</span> <span class="tok-s2">&quot;taiga-back-secret-key&quot;</span><span class="tok-p">,</span>&#x000A; <span class="tok-nt">&quot;webSocketServer&quot;</span><span class="tok-p">:</span> <span class="tok-p">{</span>&#x000A; <span class="tok-nt">&quot;port&quot;</span><span class="tok-p">:</span> <span class="tok-mi">8888</span>&#x000A; <span class="tok-p">}</span>&#x000A;<span class="tok-p">}</span></code></pre>
</div>
</div>
<div class="listingblock">
<div class="title">Now run the taiga events service</div>
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>coffee index.coffee</code></pre>
</div>
</div>
</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-04-03 21:41:45 +0200
</div>
</div>
</div>
</div>
</div>
<script>
new mlPushMenu( document.getElementById( 'toc' ), document.getElementById( 'trigger' ), {type : 'cover'} );
$( ".mp-level[data-level!=1]" ).each( function() {$(this).parents("li").addClass('icon icon-arrow-left'); } );
</script>