[{"data":1,"prerenderedAt":604},["ShallowReactive",2],{"navigation":3,"/docs/command-reference/up":285,"/docs/command-reference/up-surround":599},[4],{"title":5,"path":6,"stem":7,"children":8},"Introduction","/docs","docs/1.index",[9,10,36,53,70,83,100,121,138,155,176],{"title":5,"path":6,"stem":7},{"title":11,"path":12,"stem":13,"children":14,"page":35},"Installation","/docs/installation","docs/1.installation",[15,19,23,27,31],{"title":16,"path":17,"stem":18},"Install to macOS","/docs/installation/install-macos","docs/1.installation/1.install-macos",{"title":20,"path":21,"stem":22},"Install to Windows","/docs/installation/install-windows","docs/1.installation/2.install-windows",{"title":24,"path":25,"stem":26},"Install to Linux","/docs/installation/install-linux","docs/1.installation/3.install-linux",{"title":28,"path":29,"stem":30},"Install via Composer","/docs/installation/install-composer","docs/1.installation/4.install-composer",{"title":32,"path":33,"stem":34},"Install via NPM/Yarn","/docs/installation/install-npm-yarn","docs/1.installation/5.install-npm-yarn",false,{"title":37,"path":38,"stem":39,"children":40,"page":35},"Community","/docs/community","docs/11.community",[41,45,49],{"title":42,"path":43,"stem":44},"Get Help","/docs/community/get-help","docs/11.community/1.get-help",{"title":46,"path":47,"stem":48},"Testing New Releases","/docs/community/testing","docs/11.community/2.testing",{"title":50,"path":51,"stem":52},"Contributing","/docs/community/contributing","docs/11.community/3.contributing",{"title":54,"path":55,"stem":56,"children":57,"page":35},"Getting Started","/docs/getting-started","docs/2.getting-started",[58,62,66],{"title":59,"path":60,"stem":61},"How Spin Works","/docs/getting-started/how-spin-works","docs/2.getting-started/1.how-spin-works",{"title":63,"path":64,"stem":65},"Create a New Project with Spin","/docs/getting-started/create-a-new-project-with-spin","docs/2.getting-started/2.create-a-new-project-with-spin",{"title":67,"path":68,"stem":69},"Add Spin to an Existing Project","/docs/getting-started/add-spin-to-an-existing-project","docs/2.getting-started/3.add-spin-to-an-existing-project",{"title":71,"path":72,"stem":73,"children":74,"page":35},"Development Environment","/docs/development-environment","docs/3.development-environment",[75,79],{"title":76,"path":77,"stem":78},"Starting Up Your Development Environment","/docs/development-environment/starting-up-your-development-environment","docs/3.development-environment/1.starting-up-your-development-environment",{"title":80,"path":81,"stem":82},"Running Commands in Development","/docs/development-environment/running-commands-in-development","docs/3.development-environment/2.running-commands-in-development",{"title":84,"path":85,"stem":86,"children":87,"page":35},"Server Configuration","/docs/server-configuration","docs/4.server-configuration",[88,92,96],{"title":89,"path":90,"stem":91},"Server Requirements","/docs/server-configuration/server-requirements","docs/4.server-configuration/1.server-requirements",{"title":93,"path":94,"stem":95},"Server Configuration Basics","/docs/server-configuration/server-configuration-basics","docs/4.server-configuration/2.server-configuration-basics",{"title":97,"path":98,"stem":99},".spin.yml Usage","/docs/server-configuration/spin-yml-usage","docs/4.server-configuration/3.spin-yml-usage",{"title":101,"path":102,"stem":103,"children":104,"page":35},"Providers","/docs/providers","docs/5.providers",[105,109,113,117],{"title":106,"path":107,"stem":108},"DigitalOcean","/docs/providers/digitalocean","docs/5.providers/0.digitalocean",{"title":110,"path":111,"stem":112},"Hetzner","/docs/providers/hetzner","docs/5.providers/0.hetzner",{"title":114,"path":115,"stem":116},"Vultr","/docs/providers/vultr","docs/5.providers/0.vultr",{"title":118,"path":119,"stem":120},"Use Any Host","/docs/providers/use-any-host","docs/5.providers/99.use-any-host",{"title":122,"path":123,"stem":124,"children":125,"page":35},"Deployment","/docs/deployment","docs/6.deployment",[126,130,134],{"title":127,"path":128,"stem":129},"Choosing a Deployment Strategy","/docs/deployment/choosing-a-deployment-strategy","docs/6.deployment/1.choosing-a-deployment-strategy",{"title":131,"path":132,"stem":133},"Automated Deployments with GitHub Actions","/docs/deployment/automated-deployments-with-github-actions","docs/6.deployment/2.automated-deployments-with-github-actions",{"title":135,"path":136,"stem":137},"Using \"spin deploy\"","/docs/deployment/using-spin-deploy","docs/6.deployment/3.using-spin-deploy",{"title":139,"path":140,"stem":141,"children":142,"page":35},"Server Access","/docs/server-access","docs/7.server-access",[143,147,151],{"title":144,"path":145,"stem":146},"Connecting to Your Server","/docs/server-access/connecting-to-your-server","docs/7.server-access/1.connecting-to-your-server",{"title":148,"path":149,"stem":150},"Troubleshooting Your Application","/docs/server-access/troubleshooting-your-application","docs/7.server-access/2.troubleshooting-your-application",{"title":152,"path":153,"stem":154},"Updating Your Server","/docs/server-access/updating-your-server","docs/7.server-access/3.updating-your-server",{"title":156,"path":157,"stem":158,"children":159,"page":35},"Advanced","/docs/advanced","docs/8.advanced",[160,164,168,172],{"title":161,"path":162,"stem":163},"Generating a Secure SSH Key","/docs/advanced/generating-a-secure-ssh-key","docs/8.advanced/2.generating-a-secure-ssh-key",{"title":165,"path":166,"stem":167},"Adding Other Services","/docs/advanced/adding-other-services","docs/8.advanced/3.adding-other-services",{"title":169,"path":170,"stem":171},"Create your own Spin Template","/docs/advanced/create-your-own-template","docs/8.advanced/99.create-your-own-template",{"title":173,"path":174,"stem":175},"Migrating from Spin v2 to v3","/docs/advanced/migrating-from-spin-v2-to-v3","docs/8.advanced/migrating-from-spin-v2-to-v3",{"title":177,"path":178,"stem":179,"children":180,"page":35},"Command Reference","/docs/command-reference","docs/9.command-reference",[181,185,189,193,197,201,205,209,213,217,221,225,229,233,237,241,245,249,253,257,261,265,269,273,277,281],{"title":182,"path":183,"stem":184},"base64","/docs/command-reference/base64","docs/9.command-reference/base64",{"title":186,"path":187,"stem":188},"build","/docs/command-reference/build","docs/9.command-reference/build",{"title":190,"path":191,"stem":192},"configure","/docs/command-reference/configure","docs/9.command-reference/configure",{"title":194,"path":195,"stem":196},"debug","/docs/command-reference/debug","docs/9.command-reference/debug",{"title":198,"path":199,"stem":200},"deploy","/docs/command-reference/deploy","docs/9.command-reference/deploy",{"title":202,"path":203,"stem":204},"down","/docs/command-reference/down","docs/9.command-reference/down",{"title":206,"path":207,"stem":208},"exec","/docs/command-reference/exec","docs/9.command-reference/exec",{"title":210,"path":211,"stem":212},"gh","/docs/command-reference/gh","docs/9.command-reference/gh",{"title":214,"path":215,"stem":216},"help","/docs/command-reference/help","docs/9.command-reference/help",{"title":218,"path":219,"stem":220},"init","/docs/command-reference/init","docs/9.command-reference/init",{"title":222,"path":223,"stem":224},"kill","/docs/command-reference/kill","docs/9.command-reference/kill",{"title":226,"path":227,"stem":228},"latest","/docs/command-reference/latest","docs/9.command-reference/latest",{"title":230,"path":231,"stem":232},"logs","/docs/command-reference/logs","docs/9.command-reference/logs",{"title":234,"path":235,"stem":236},"maintain","/docs/command-reference/maintain","docs/9.command-reference/maintain",{"title":238,"path":239,"stem":240},"mkpasswd","/docs/command-reference/mkpasswd","docs/9.command-reference/mkpasswd",{"title":242,"path":243,"stem":244},"new","/docs/command-reference/new","docs/9.command-reference/new",{"title":246,"path":247,"stem":248},"provision","/docs/command-reference/provision","docs/9.command-reference/provision",{"title":250,"path":251,"stem":252},"prune","/docs/command-reference/prune","docs/9.command-reference/prune",{"title":254,"path":255,"stem":256},"ps","/docs/command-reference/ps","docs/9.command-reference/ps",{"title":258,"path":259,"stem":260},"pull","/docs/command-reference/pull","docs/9.command-reference/pull",{"title":262,"path":263,"stem":264},"run","/docs/command-reference/run","docs/9.command-reference/run",{"title":266,"path":267,"stem":268},"stop","/docs/command-reference/stop","docs/9.command-reference/stop",{"title":270,"path":271,"stem":272},"up","/docs/command-reference/up","docs/9.command-reference/up",{"title":274,"path":275,"stem":276},"update","/docs/command-reference/update","docs/9.command-reference/update",{"title":278,"path":279,"stem":280},"vault","/docs/command-reference/vault","docs/9.command-reference/vault",{"title":282,"path":283,"stem":284},"version","/docs/command-reference/version","docs/9.command-reference/version",{"id":286,"title":270,"body":287,"canonical":589,"description":590,"extension":591,"layout":592,"meta":593,"navigation":596,"path":271,"seo":597,"stem":272,"__hash__":598},"docs/docs/9.command-reference/up.md",{"type":288,"value":289,"toc":576},"minimark",[290,314,319,346,350,364,380,387,391,398,425,429,434,450,455,469,473,495,501,504,513,521,527,548,551,572],[291,292,293],"lead-p",{},[294,295,296,297,301,302,305,306,309,310,313],"p",{},"Bring up all containers defined in ",[298,299,300],"code",{},"docker-compose.yml"," and ",[298,303,304],{},"docker-compose.$SPIN_ENV.yml"," (",[298,307,308],{},"$SPIN_ENV"," defaults to ",[298,311,312],{},"dev",").",[315,316,318],"h2",{"id":317},"usage","Usage",[320,321,327],"pre",{"className":322,"code":323,"filename":324,"language":325,"meta":326,"style":326},"language-bash shiki shiki-themes material-theme-lighter github-dark github-dark","spin up [OPTIONS]\n","Usage for \"spin up\"","bash","",[298,328,329],{"__ignoreMap":326},[330,331,334,338,342],"span",{"class":332,"line":333},"line",1,[330,335,337],{"class":336},"soiBB","spin",[330,339,341],{"class":340},"s0vBq"," up",[330,343,345],{"class":344},"sMo7A"," [OPTIONS]\n",[315,347,349],{"id":348},"example","Example",[351,352,353],"note",{},[294,354,355,356,359,360,363],{},"If you're using a Docker Compose configuration with ",[298,357,358],{},"build:"," directives, you might want to get in the habit of using ",[298,361,362],{},"spin up --build"," to ensure you're always running the latest version of your containers.",[320,365,368],{"className":322,"code":366,"filename":367,"language":325,"meta":326,"style":326},"spin up --build\n","Force a build of containers on initialization",[298,369,370],{"__ignoreMap":326},[330,371,372,374,376],{"class":332,"line":333},[330,373,337],{"class":336},[330,375,341],{"class":340},[330,377,379],{"class":378},"sSJ72"," --build\n",[294,381,382,383,386],{},"You can add options at the end of the command (like the ",[298,384,385],{},"--build"," shown above. The above command will bring up your containers, but then also force a new build (if you have builds configured in your \"docker-compose.dev.yml\" file).",[315,388,390],{"id":389},"defaults","Defaults",[294,392,393,394,397],{},"The ",[298,395,396],{},"spin up"," command defaults to running:",[320,399,402],{"className":322,"code":400,"filename":401,"language":325,"meta":326,"style":326},"COMPOSE_FILE=docker-compose.yml:docker-compose.dev.yml docker compose up\n","Command default",[298,403,404],{"__ignoreMap":326},[330,405,406,409,413,416,419,422],{"class":332,"line":333},[330,407,408],{"class":344},"COMPOSE_FILE",[330,410,412],{"class":411},"sFfmW","=",[330,414,415],{"class":340},"docker-compose.yml:docker-compose.dev.yml",[330,417,418],{"class":336}," docker",[330,420,421],{"class":340}," compose",[330,423,424],{"class":340}," up\n",[315,426,428],{"id":427},"official-documentation-additional-options","Official Documentation & Additional Options",[430,431,433],"h4",{"id":432},"spin-specific-options","Spin Specific Options",[435,436,437,444],"ul",{},[438,439,440,443],"li",{},[298,441,442],{},"--skip-pull",": Do not automatically pull docker images.",[438,445,446,449],{},[298,447,448],{},"--force-pull",": Pull Docker Compose images, regardless of cache settings.",[451,452,454],"h3",{"id":453},"official-docker-options","Official Docker Options",[294,456,457,458,468],{},"This command is a shortcut for ",[459,460,465],"a",{"href":461,"rel":462,"target":464},"https://docs.docker.com/compose/reference/up/",[463],"nofollow","_blank",[298,466,467],{},"docker compose up"," and can accept additional options that you pass to it. It also does a number of other special things.",[315,470,472],{"id":471},"special-notes","Special notes",[435,474,475,489,492],{},[438,476,477,478,301,480,484,485,488],{},"Make sure to have a ",[298,479,300],{},[481,482,483],"strong",{},"by default"," a ",[298,486,487],{},"docker-compose.dev.yml"," in your project before running",[438,490,491],{},"Spin will automatically pull image updates (only if the machine is connected to the Internet)",[438,493,494],{},"Spin will remove any orphan containers",[315,496,498,499],{"id":497},"overriding-the-environment-with-spin_env","Overriding the environment with ",[298,500,308],{},[294,502,503],{},"Let's say you have a few different files in your repository:",[320,505,511],{"className":506,"code":508,"filename":509,"language":510,"meta":326},[507],"language-text",".\n├── docker-compose.ci.yml\n├── docker-compose.production.yml\n├── docker-compose.staging.yml\n├── docker-compose.testing.yml\n└── docker-compose.yml\n","Example project root","text",[298,512,508],{"__ignoreMap":326},[294,514,515,516,301,518,520],{},"By default, Spin uses ",[298,517,300],{},[298,519,487],{},".",[294,522,523,524,526],{},"If you want to change that, you just need to set ",[298,525,308],{},":",[320,528,531],{"className":322,"code":529,"filename":530,"language":325,"meta":326,"style":326},"SPIN_ENV=testing spin up\n","Change spin environment",[298,532,533],{"__ignoreMap":326},[330,534,535,538,540,543,546],{"class":332,"line":333},[330,536,537],{"class":344},"SPIN_ENV",[330,539,412],{"class":411},[330,541,542],{"class":340},"testing",[330,544,545],{"class":336}," spin",[330,547,424],{"class":340},[294,549,550],{},"This will essentially run:",[320,552,555],{"className":322,"code":553,"filename":554,"language":325,"meta":326,"style":326},"COMPOSE_FILE=docker-compose.yml:docker-compose.testing.yml docker compose up\n","Above command will execute this below",[298,556,557],{"__ignoreMap":326},[330,558,559,561,563,566,568,570],{"class":332,"line":333},[330,560,408],{"class":344},[330,562,412],{"class":411},[330,564,565],{"class":340},"docker-compose.yml:docker-compose.testing.yml",[330,567,418],{"class":336},[330,569,421],{"class":340},[330,571,424],{"class":340},[573,574,575],"style",{},"html pre.shiki code .soiBB, html code.shiki .soiBB{--shiki-light:#E2931D;--shiki-default:#B392F0;--shiki-dark:#B392F0}html pre.shiki code .s0vBq, html code.shiki .s0vBq{--shiki-light:#91B859;--shiki-default:#9ECBFF;--shiki-dark:#9ECBFF}html pre.shiki code .sMo7A, html code.shiki .sMo7A{--shiki-light:#90A4AE;--shiki-default:#E1E4E8;--shiki-dark:#E1E4E8}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sSJ72, html code.shiki .sSJ72{--shiki-light:#91B859;--shiki-default:#79B8FF;--shiki-dark:#79B8FF}html pre.shiki code .sFfmW, html code.shiki .sFfmW{--shiki-light:#39ADB5;--shiki-default:#F97583;--shiki-dark:#F97583}",{"title":326,"searchDepth":577,"depth":577,"links":578},2,[579,580,581,582,586,587],{"id":317,"depth":577,"text":318},{"id":348,"depth":577,"text":349},{"id":389,"depth":577,"text":390},{"id":427,"depth":577,"text":428,"children":583},[584],{"id":453,"depth":585,"text":454},3,{"id":471,"depth":577,"text":472},{"id":497,"depth":577,"text":588},"Overriding the environment with $SPIN_ENV","https://serversideup.net/open-source/spin/docs/command-reference/up","Command reference for \"spin up\"","md","docs",{"head":594},{"title":595},"up | Command Reference - Spin by Server Side Up",true,{"title":270,"description":590},"5k7Go3tnmIar0qM1v3uyiFBaR1n952GxWoDGmt_0z0M",[600,602],{"title":266,"path":267,"stem":268,"description":601,"children":-1},"Command reference for \"spin stop\"",{"title":274,"path":275,"stem":276,"description":603,"children":-1},"Command reference for \"spin update\"",1769465042667]