{"__v":0,"_id":"588f722bbcace50f0052b9ff","category":{"version":"588f722bbcace50f0052b9e1","project":"565f5fa26bafd40d0030a064","_id":"588f722bbcace50f0052b9e7","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-12-17T21:29:23.551Z","from_sync":false,"order":5,"slug":"server-installation-configuration","title":"Self Hosting"},"parentDoc":null,"project":"565f5fa26bafd40d0030a064","user":"565f3941ea46251700972783","version":{"__v":1,"_id":"588f722bbcace50f0052b9e1","project":"565f5fa26bafd40d0030a064","createdAt":"2017-01-30T17:04:43.410Z","releaseDate":"2017-01-30T17:04:43.410Z","categories":["588f722bbcace50f0052b9e2","588f722bbcace50f0052b9e3","588f722bbcace50f0052b9e4","588f722bbcace50f0052b9e5","588f722bbcace50f0052b9e6","588f722bbcace50f0052b9e7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"5.3.0","version":"5.3.0"},"updates":["57e5483703746919001f0d42","57ea8d971780cd170064f283","57eaed220392f60e001251f3","58540252f5b3b2230039b4a2"],"next":{"pages":[],"description":""},"createdAt":"2015-12-08T19:04:47.458Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"Nanoscale.io can be run in three different modes, providing compete flexibility for different development and production use cases:\n\n1. **Local Mode**\n2. **Single Server Mode**\n3. **Clustered Server Mode**\n\n## Local Mode\n\nLocal mode allows the nanoscale.io to be conveniently used by a single developer in a self-contained environment on a laptop or desktop computer. This mode is typically used by a developer to develop and test API calls quickly.  This mode utilizes a built-in SQLite database to store API configuration metadata, and is not recommended for multiple developers or serving up APIs for a purpose other than development. For more information please refer to [Start the nanoscale.io Server](doc:start-the-justapis-server) \n\n## Single Server Mode\n\nSingle Server Mode is typically used to run nanoscale.io within a shared development environment or for low-volume production scenarios.  In this mode, multiple developers can utilize the same nanoscale.io instance to build and test APIs. When running in Single Server Mode, nanoscale.io requires a PostgreSQL database to store API configuration metadata. For more information please refer to [Deploy nanoscale.io on a Server](doc:deploy-justapis-on-a-server) .\n\n## Clustered Server Mode\n\nDeploying nanoscale.io in Clustered Server Mode enables nanoscale.io to execute in a highly scalable deployment environment with multiple nanoscale.io instances, typically with a load balancer such as Citrix NetScaler or NGINX.  When running in Clustered Server Mode, nanoscale.io requires a PostgreSQL database to store API configuration metadata, which is shared by all nanoscale.io instances.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Download your copy of nanoscale.io\",\n  \"body\": \"When you signed up for the cloud instance of nanoscale.io, your welcome email should have included links for you to download your own copy of the software. This version is open source.\"\n}\n[/block]","excerpt":"","slug":"running-justapis","type":"basic","title":"Running the nanoscale.io server"}

Running the nanoscale.io server


Nanoscale.io can be run in three different modes, providing compete flexibility for different development and production use cases: 1. **Local Mode** 2. **Single Server Mode** 3. **Clustered Server Mode** ## Local Mode Local mode allows the nanoscale.io to be conveniently used by a single developer in a self-contained environment on a laptop or desktop computer. This mode is typically used by a developer to develop and test API calls quickly. This mode utilizes a built-in SQLite database to store API configuration metadata, and is not recommended for multiple developers or serving up APIs for a purpose other than development. For more information please refer to [Start the nanoscale.io Server](doc:start-the-justapis-server) ## Single Server Mode Single Server Mode is typically used to run nanoscale.io within a shared development environment or for low-volume production scenarios. In this mode, multiple developers can utilize the same nanoscale.io instance to build and test APIs. When running in Single Server Mode, nanoscale.io requires a PostgreSQL database to store API configuration metadata. For more information please refer to [Deploy nanoscale.io on a Server](doc:deploy-justapis-on-a-server) . ## Clustered Server Mode Deploying nanoscale.io in Clustered Server Mode enables nanoscale.io to execute in a highly scalable deployment environment with multiple nanoscale.io instances, typically with a load balancer such as Citrix NetScaler or NGINX. When running in Clustered Server Mode, nanoscale.io requires a PostgreSQL database to store API configuration metadata, which is shared by all nanoscale.io instances. [block:callout] { "type": "info", "title": "Download your copy of nanoscale.io", "body": "When you signed up for the cloud instance of nanoscale.io, your welcome email should have included links for you to download your own copy of the software. This version is open source." } [/block]