diff options
Diffstat (limited to 'assets/js/eceb215a.bef6e109.js')
| -rw-r--r-- | assets/js/eceb215a.bef6e109.js | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/assets/js/eceb215a.bef6e109.js b/assets/js/eceb215a.bef6e109.js new file mode 100644 index 0000000..9afe63f --- /dev/null +++ b/assets/js/eceb215a.bef6e109.js @@ -0,0 +1 @@ +(self.webpackChunksite=self.webpackChunksite||[]).push([[7922],{4137:function(e,t,n){"use strict";n.d(t,{Zo:function(){return p},kt:function(){return m}});var r=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?o(Object(n),!0).forEach((function(t){i(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):o(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function a(e,t){if(null==e)return{};var n,r,i=function(e,t){if(null==e)return{};var n,r,i={},o=Object.keys(e);for(r=0;r<o.length;r++)n=o[r],t.indexOf(n)>=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r<o.length;r++)n=o[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var c=r.createContext({}),s=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},p=function(e){var t=s(e.components);return r.createElement(c.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,o=e.originalType,c=e.parentName,p=a(e,["components","mdxType","originalType","parentName"]),d=s(n),m=i,h=d["".concat(c,".").concat(m)]||d[m]||u[m]||o;return n?r.createElement(h,l(l({ref:t},p),{},{components:n})):r.createElement(h,l({ref:t},p))}));function m(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var o=n.length,l=new Array(o);l[0]=d;var a={};for(var c in t)hasOwnProperty.call(t,c)&&(a[c]=t[c]);a.originalType=e,a.mdxType="string"==typeof e?e:i,l[1]=a;for(var s=2;s<o;s++)l[s]=n[s];return r.createElement.apply(null,l)}return r.createElement.apply(null,n)}d.displayName="MDXCreateElement"},4713:function(e,t,n){"use strict";n.r(t),n.d(t,{frontMatter:function(){return l},contentTitle:function(){return a},metadata:function(){return c},toc:function(){return s},default:function(){return u}});var r=n(2122),i=n(9756),o=(n(7294),n(4137)),l={title:"Deploying (Setup)"},a=void 0,c={unversionedId:"whirl/deploying_setup",id:"whirl/deploying_setup",isDocsHomePage:!1,title:"Deploying (Setup)",description:"So you want to deploy your own WhirlServer? Nice! You've come to the right",source:"@site/docs/whirl/deploying_setup.md",sourceDirName:"whirl",slug:"/whirl/deploying_setup",permalink:"/docs/whirl/deploying_setup",editUrl:"https://github.com/whirlsplash/site/edit/master/website/docs/whirl/deploying_setup.md",version:"current",frontMatter:{title:"Deploying (Setup)"},sidebar:"docs",previous:{title:"Setting up a development environment",permalink:"/docs/introduction/setting_up_a_development_environment"},next:{title:"Configuration",permalink:"/docs/whirl/configuration"}},s=[{value:"With Docker",id:"with-docker",children:[{value:"Prerequisites",id:"prerequisites",children:[]},{value:"Usage",id:"usage",children:[]},{value:"Notes",id:"notes",children:[]}]},{value:"With Docker Compose",id:"with-docker-compose",children:[{value:"Prerequisites",id:"prerequisites-1",children:[]},{value:"Usage",id:"usage-1",children:[]},{value:"Notes",id:"notes-1",children:[]}]},{value:"With a Standalone Binary (Currently only for developmental use)",id:"with-a-standalone-binary-currently-only-for-developmental-use",children:[{value:"Notes",id:"notes-2",children:[]}]},{value:"Notes",id:"notes-3",children:[]}],p={toc:s};function u(e){var t=e.components,n=(0,i.Z)(e,["components"]);return(0,o.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,"So you want to deploy your own WhirlServer? Nice! You've come to the right\nplace!"),(0,o.kt)("h2",{id:"with-docker"},"With Docker"),(0,o.kt)("h3",{id:"prerequisites"},"Prerequisites"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"https://docs.docker.com/engine/install/"},"Docker"))),(0,o.kt)("h3",{id:"usage"},"Usage"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-shell"},"$ docker run \\\n> -d \\\n> -p 8080:80 \\\n> -p 6650:6650 \\\n> -p 5673:5673 \\\n> -v /var/lib/whirl:/.whirl \\\n> whirlsplash/whirl\n")),(0,o.kt)("h4",{id:"copyable"},"Copyable"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-shell"},"docker run -d -p 8080:80 -p 6650:6650 -p 5673:5673 -v /var/lib/whirl:/.whirl whirlsplash/whirl\n")),(0,o.kt)("h3",{id:"notes"},"Notes"),(0,o.kt)("p",null,"Your configuration file can be found in ",(0,o.kt)("inlineCode",{parentName:"p"},"/var/lib/whirl/"),"."),(0,o.kt)("h2",{id:"with-docker-compose"},"With Docker Compose"),(0,o.kt)("h3",{id:"prerequisites-1"},"Prerequisites"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"https://docs.docker.com/compose/install/"},"Docker")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"https://docs.docker.com/compose/install/"},"Docker Compose")," (newer versions of\nDocker include Docker Compose!)")),(0,o.kt)("h3",{id:"usage-1"},"Usage"),(0,o.kt)("ol",null,(0,o.kt)("li",{parentName:"ol"},"Create a directory, preferably in a monitorable location, ",(0,o.kt)("inlineCode",{parentName:"li"},"cd")," into it, and\ncreate a file named ",(0,o.kt)("inlineCode",{parentName:"li"},"docker-compose.yml")," with the following contents:")),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-yml"},'# docker-compose.yml\n\nversion: "3.3"\nservices:\n whirl:\n ports:\n - "8080:80" # API\n - "6650:6650" # Distributor\n - "5673:5673" # Hub\n volumes:\n - ./.whirl-data:/.whirl\n image: whirlsplash/whirl\n')),(0,o.kt)("ol",{start:2},(0,o.kt)("li",{parentName:"ol"},"Execute ",(0,o.kt)("inlineCode",{parentName:"li"},"docker-compose up")," (or ",(0,o.kt)("inlineCode",{parentName:"li"},"docker compose up")," in later versions of\nDocker)."),(0,o.kt)("li",{parentName:"ol"},"Wait around five seconds, if no errors are logged; ",(0,o.kt)("inlineCode",{parentName:"li"},"Ctrl + C")," the process.\nWhirl has now generated a default configuration file for you in the\n",(0,o.kt)("inlineCode",{parentName:"li"},"./whirl-data/")," directory, ",(0,o.kt)("inlineCode",{parentName:"li"},"cd")," into this directory and modify the\n",(0,o.kt)("inlineCode",{parentName:"li"},"Config.toml")," to your liking."),(0,o.kt)("li",{parentName:"ol"},"You may now ",(0,o.kt)("inlineCode",{parentName:"li"},"cd")," back into the originally created directory and execute\n",(0,o.kt)("inlineCode",{parentName:"li"},"docker-compose up -d")," (or ",(0,o.kt)("inlineCode",{parentName:"li"},"docker compose up -d")," in later versions of\nDocker).")),(0,o.kt)("h3",{id:"notes-1"},"Notes"),(0,o.kt)("p",null,"Your configuration file can be found in ",(0,o.kt)("inlineCode",{parentName:"p"},"./whirl-data/"),"."),(0,o.kt)("h2",{id:"with-a-standalone-binary-currently-only-for-developmental-use"},"With a Standalone Binary (Currently only for developmental use)"),(0,o.kt)("ol",null,(0,o.kt)("li",{parentName:"ol"},"Create a directory, preferably in a monitorable location and ",(0,o.kt)("inlineCode",{parentName:"li"},"cd")," into it."),(0,o.kt)("li",{parentName:"ol"},"Download the latest binary release of your platform (if available) from the\nWhirl ",(0,o.kt)("a",{parentName:"li",href:"https://github.com/Whirlsplash/whirl/releases/latest"},"releases page"),"."),(0,o.kt)("li",{parentName:"ol"},"Execute ",(0,o.kt)("inlineCode",{parentName:"li"},"whirl run distributor")),(0,o.kt)("li",{parentName:"ol"},"Wait around five seconds, if no errors are logged: ",(0,o.kt)("inlineCode",{parentName:"li"},"Ctrl + C")," the process.\nWhirl has now generated a default configuration file for you in the\n",(0,o.kt)("inlineCode",{parentName:"li"},"./whirl/")," directory, ",(0,o.kt)("inlineCode",{parentName:"li"},"cd")," into this directory and modify the\n",(0,o.kt)("inlineCode",{parentName:"li"},"Config.toml")," to your liking."),(0,o.kt)("li",{parentName:"ol"},"You may now ",(0,o.kt)("inlineCode",{parentName:"li"},"cd")," back into the originally created directory and execute\n",(0,o.kt)("inlineCode",{parentName:"li"},"whirl run")," (or ",(0,o.kt)("inlineCode",{parentName:"li"},"whirl run distributor,hub")," if you would like to run only a\nselect few of Whirl's sub-servers).")),(0,o.kt)("h3",{id:"notes-2"},"Notes"),(0,o.kt)("p",null,"Your configuration file can be found in ",(0,o.kt)("inlineCode",{parentName:"p"},"./whirl/"),"."),(0,o.kt)("h2",{id:"notes-3"},"Notes"),(0,o.kt)("p",null,"systemd configuration may (?) come soon!"))}u.isMDXComponent=!0}}]);
\ No newline at end of file |