{"__v":3,"_id":"5635b293d209b50d0031dfd8","category":{"__v":1,"_id":"5635b291d209b50d0031dfc5","pages":["5635b293d209b50d0031dfd6","5635b293d209b50d0031dfd7","5635b293d209b50d0031dfd8","5635b293d209b50d0031dfd9","5635b293d209b50d0031dfda","5635b293d209b50d0031dfdb","5635b293d209b50d0031dfdc","5635b293d209b50d0031dfdd","5635b293d209b50d0031dfde"],"project":"550a7754635c660d0052808e","version":"5635b290d209b50d0031dfc4","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-03-19T07:14:29.230Z","from_sync":false,"order":0,"slug":"getting-started","title":"Getting Started"},"project":"550a7754635c660d0052808e","user":"5469e5dfa3b67a0e00559b06","version":{"__v":1,"_id":"5635b290d209b50d0031dfc4","project":"550a7754635c660d0052808e","createdAt":"2015-11-01T06:34:56.868Z","releaseDate":"2015-11-01T06:34:56.868Z","categories":["5635b291d209b50d0031dfc5","5635b291d209b50d0031dfc6","5635b291d209b50d0031dfc7","5635b291d209b50d0031dfc8","5635b291d209b50d0031dfc9","5635b291d209b50d0031dfca"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"0.25.0","version":"0.25"},"updates":["55f15adaf3735d0d00692165","58b654414088010f000f6d5f"],"next":{"pages":[],"description":""},"createdAt":"2015-04-09T03:27:56.175Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"**IMPORTANT: [Nova](https://github.com/TelescopeJS/Telescope/tree/nova) is a new, React-based version of Telescope. Although it's still beta software, it is recommended you use it for any new projects going forward.**\n\nThere are many ways to deploy Telescope, and here are a few of them. \n\nNote that this is meant as an introduction to these various options, not as a replacement for reading their respective documentation.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Option 1: Heroku\"\n}\n[/block]\nYou can easily deploy Telescope to Heroku thanks to their one-click deploy: \n\n[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/TelescopeJS/sample-project)\n\n#### Pros\n\n- Free to try.\n- No need to install the app locally.\n\n#### Cons\n\n- No official Meteor support.\n- Modifying and redeploying your app (in order to update it, install third-party themes, etc.) requires familiarity with Heroku's Git-based workflow.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Updating Your Heroku App\",\n  \"body\": \"Heroku does not let you modify your app or run command on your instance. Practically speaking, this means that in order to change anything in your app (including updating it or adding themes), you'll need to first pull its code locally using [Git](https://devcenter.heroku.com/articles/git).\\n\\nHere's a quick walkthrough (note that it requires installing [Meteor](http://meteor.com) as well as the [Git](https://git-scm.com/) command line utility first):\\n\\n- Go to your app's Settings page on Heroku and find the **Git URL** (typically, `git:::at:::heroku.com:my_app_name.git`).\\n- On your local machine, clone the repository with `git clone git@heroku.com:my_app_name.git`. Note that you might need to authenticate yourself with Heroku (using the `heroku login` command) first.\\n- Drill down into the directory with `cd my_app_name`.\\n- Apply the changes you want (for example, `meteor update` to update the app).\\n- Add and commit the result with `git add -A` and then `git commit -m \\\"updated the app\\\"`.\\n- Push and deploy to Heroku with `git push`.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Option 2: Scalingo\"\n}\n[/block]\nScalingo is another hosting service that provides a one-click deploy option:\n\n[Deploy on Scalingo now](https://my.scalingo.com/deploy?source=https://github.com/TelescopeJS/sample-project/)\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Option 3: Meteor.com\"\n}\n[/block]\nYou can deploy any Meteor app to Meteor's own free hosting on *.meteor.com. \n\nYou'll find more information about it [in the official Meteor documentation](http://docs.meteor.com/#deploying), but be warned that this free offering is not suitable for production apps, and will not be able to handle large amount of traffic. \n\nJust follow the instructions to get Telescope running locally, and then type `meteor deploy xyz`, where \"xyz\" is the name of your app.\n\n#### Pros\n\n- Free.\n- Super-simple.\n- Just works out of the box.\n\n#### Cons\n\n- Not production-ready.\n- Requires having the app running locally.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Option 4: MeteorUp + Digital Ocean + Compose.io\"\n}\n[/block]\nYou can easily deploy on your own server, such as a [Digital Ocean](https://www.digitalocean.com/), [Amazon EC2](http://aws.amazon.com/ec2/), or [Linode](https://www.linode.com/) instance using a tool called [Meteor Up](https://github.com/arunoda/meteor-up), or `mup` for short.\n[block:embed]\n{\n  \"html\": \"<iframe class=\\\"embedly-embed\\\" src=\\\"//cdn.embedly.com/widgets/media.html?src=http%3A%2F%2Fwww.youtube.com%2Fembed%2FWLGdXtZMmiI%3Ffeature%3Doembed&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DWLGdXtZMmiI&image=http%3A%2F%2Fi.ytimg.com%2Fvi%2FWLGdXtZMmiI%2Fhqdefault.jpg&key=02466f963b9b4bb8845a05b53d3235d7&type=text%2Fhtml&schema=youtube\\\" width=\\\"640\\\" height=\\\"480\\\" scrolling=\\\"no\\\" frameborder=\\\"0\\\" allowfullscreen></iframe>\",\n  \"url\": \"https://www.youtube.com/watch?v=WLGdXtZMmiI\",\n  \"title\": \"Deploying With Digital Ocean, Compose.io, and Meteor Up\",\n  \"favicon\": \"https://www.youtube.com/favicon.ico\",\n  \"image\": \"http://i.ytimg.com/vi/WLGdXtZMmiI/hqdefault.jpg\"\n}\n[/block]\nJust fill in your instance's IP along with your ssh username and password, and Meteor Up will take care of the server setup and any subsequent deployments for you. \n\nI personally recommend [Digital Ocean](https://www.digitalocean.com/) for their cheap prices, clean dashboard, and great support. But make sure you pick at least a 1 GB instance ($10/month), as Telescope tends to use up all available memory and lock up on smaller instances.\n\n#### What To Do\n\n- Open a Compose.io account, create a database, and note its Mongo URL.\n- Open a Digital Ocean account, create a droplet, and note its access credentials.\n- Install Meteor Up, set up your options, then run `mup setup` and `mup deploy`. \n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"A Note About Database Hosting\",\n  \"body\": \"Although you can host your MongoDB database on the same server as your app, it's recommended you use a dedicated, third-party service like [Compose.io](http://compose.io) to host it. This will give you many advantages, such as:\\n\\n- A web dashboard that lets you access and even modify your database online.\\n- Automated back-ups.\\n- Professional support by MongoDB experts.\\n- [Oplog](https://meteorhacks.com/mongodb-oplog-and-meteor.html) support (makes your Meteor app run faster!).\\n- Having your database hosted independently makes it a lot easier to switch servers if you need to. \\n\\nAlthough Oplog support costs $18/month, you can get started for free with a Sandbox instance.\"\n}\n[/block]\n\n#### Pros\n\n- Easy to port your whole app to another service.\n- Open-source and configurable.\n\n#### Cons\n\n- A bit more involved.\n- Requires having the app running locally.\n- Not free.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If Meteor Up's deployment process fails, run the `mup logs -f` command in another terminal window to stream the logs and try deploying again to help identify the issue. \\n\\nAlso, if you want to use Oplog, make sure the database user you create is authorized for Oplog.\",\n  \"title\": \"Troubleshooting\"\n}\n[/block]","excerpt":"Deploying your app to test and production servers.","slug":"deploying","type":"basic","title":"Deploying"}

Deploying

Deploying your app to test and production servers.

**IMPORTANT: [Nova](https://github.com/TelescopeJS/Telescope/tree/nova) is a new, React-based version of Telescope. Although it's still beta software, it is recommended you use it for any new projects going forward.** There are many ways to deploy Telescope, and here are a few of them. Note that this is meant as an introduction to these various options, not as a replacement for reading their respective documentation. [block:api-header] { "type": "basic", "title": "Option 1: Heroku" } [/block] You can easily deploy Telescope to Heroku thanks to their one-click deploy: [![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/TelescopeJS/sample-project) #### Pros - Free to try. - No need to install the app locally. #### Cons - No official Meteor support. - Modifying and redeploying your app (in order to update it, install third-party themes, etc.) requires familiarity with Heroku's Git-based workflow. [block:callout] { "type": "info", "title": "Updating Your Heroku App", "body": "Heroku does not let you modify your app or run command on your instance. Practically speaking, this means that in order to change anything in your app (including updating it or adding themes), you'll need to first pull its code locally using [Git](https://devcenter.heroku.com/articles/git).\n\nHere's a quick walkthrough (note that it requires installing [Meteor](http://meteor.com) as well as the [Git](https://git-scm.com/) command line utility first):\n\n- Go to your app's Settings page on Heroku and find the **Git URL** (typically, `git@heroku.com:my_app_name.git`).\n- On your local machine, clone the repository with `git clone git@heroku.com:my_app_name.git`. Note that you might need to authenticate yourself with Heroku (using the `heroku login` command) first.\n- Drill down into the directory with `cd my_app_name`.\n- Apply the changes you want (for example, `meteor update` to update the app).\n- Add and commit the result with `git add -A` and then `git commit -m \"updated the app\"`.\n- Push and deploy to Heroku with `git push`." } [/block] [block:api-header] { "type": "basic", "title": "Option 2: Scalingo" } [/block] Scalingo is another hosting service that provides a one-click deploy option: [Deploy on Scalingo now](https://my.scalingo.com/deploy?source=https://github.com/TelescopeJS/sample-project/) [block:api-header] { "type": "basic", "title": "Option 3: Meteor.com" } [/block] You can deploy any Meteor app to Meteor's own free hosting on *.meteor.com. You'll find more information about it [in the official Meteor documentation](http://docs.meteor.com/#deploying), but be warned that this free offering is not suitable for production apps, and will not be able to handle large amount of traffic. Just follow the instructions to get Telescope running locally, and then type `meteor deploy xyz`, where "xyz" is the name of your app. #### Pros - Free. - Super-simple. - Just works out of the box. #### Cons - Not production-ready. - Requires having the app running locally. [block:api-header] { "type": "basic", "title": "Option 4: MeteorUp + Digital Ocean + Compose.io" } [/block] You can easily deploy on your own server, such as a [Digital Ocean](https://www.digitalocean.com/), [Amazon EC2](http://aws.amazon.com/ec2/), or [Linode](https://www.linode.com/) instance using a tool called [Meteor Up](https://github.com/arunoda/meteor-up), or `mup` for short. [block:embed] { "html": "<iframe class=\"embedly-embed\" src=\"//cdn.embedly.com/widgets/media.html?src=http%3A%2F%2Fwww.youtube.com%2Fembed%2FWLGdXtZMmiI%3Ffeature%3Doembed&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DWLGdXtZMmiI&image=http%3A%2F%2Fi.ytimg.com%2Fvi%2FWLGdXtZMmiI%2Fhqdefault.jpg&key=02466f963b9b4bb8845a05b53d3235d7&type=text%2Fhtml&schema=youtube\" width=\"640\" height=\"480\" scrolling=\"no\" frameborder=\"0\" allowfullscreen></iframe>", "url": "https://www.youtube.com/watch?v=WLGdXtZMmiI", "title": "Deploying With Digital Ocean, Compose.io, and Meteor Up", "favicon": "https://www.youtube.com/favicon.ico", "image": "http://i.ytimg.com/vi/WLGdXtZMmiI/hqdefault.jpg" } [/block] Just fill in your instance's IP along with your ssh username and password, and Meteor Up will take care of the server setup and any subsequent deployments for you. I personally recommend [Digital Ocean](https://www.digitalocean.com/) for their cheap prices, clean dashboard, and great support. But make sure you pick at least a 1 GB instance ($10/month), as Telescope tends to use up all available memory and lock up on smaller instances. #### What To Do - Open a Compose.io account, create a database, and note its Mongo URL. - Open a Digital Ocean account, create a droplet, and note its access credentials. - Install Meteor Up, set up your options, then run `mup setup` and `mup deploy`. [block:callout] { "type": "info", "title": "A Note About Database Hosting", "body": "Although you can host your MongoDB database on the same server as your app, it's recommended you use a dedicated, third-party service like [Compose.io](http://compose.io) to host it. This will give you many advantages, such as:\n\n- A web dashboard that lets you access and even modify your database online.\n- Automated back-ups.\n- Professional support by MongoDB experts.\n- [Oplog](https://meteorhacks.com/mongodb-oplog-and-meteor.html) support (makes your Meteor app run faster!).\n- Having your database hosted independently makes it a lot easier to switch servers if you need to. \n\nAlthough Oplog support costs $18/month, you can get started for free with a Sandbox instance." } [/block] #### Pros - Easy to port your whole app to another service. - Open-source and configurable. #### Cons - A bit more involved. - Requires having the app running locally. - Not free. [block:callout] { "type": "info", "body": "If Meteor Up's deployment process fails, run the `mup logs -f` command in another terminal window to stream the logs and try deploying again to help identify the issue. \n\nAlso, if you want to use Oplog, make sure the database user you create is authorized for Oplog.", "title": "Troubleshooting" } [/block]