sails.getBaseUrl()
This method is deprecated and will likely be removed or changed in an upcoming release.
#There is no reliable, cross-platform way to automatically detect the external URL of a running Sails app (or any other Node app). Instead, configure your base URL explicitly and save it in custom configuration (e.g.
sails.config.custom.baseUrl) that you can reference throughout the app. (This can then be overridden in production, staging, etc. as needed using environment-dependent configuration.)
Return a (possibly incorrect) best guess of the base URL for this app, based on a combination of user-supplied and default configuration values.
sails.getBaseUrl();
getBaseUrl() constructs a URL string by inspecting various configuration values and defaults. For example, if sails.config.ssl.key and sails.config.ssl.cert both have values, the URL will start with https:// instead of http://. If sails.config.explicitHost is not undefined, its value will be used as the domain name, otherwise it will be localhost. If sails.config.port is not 80 or 443, its value will be appended to the URL as well.
Usage
#This function does not accept any arguments.
Returns
#Type:
http://localhost:1337
Example
#In an email template...
For more information, visit <a href="<%=sails.getBaseUrl()%>">our web site</a>.
For a better experience on sailsjs.com, update your browser.
Reference
- Blueprint API
- Command-line interface
-
Configuration
- sails.config.*
- sails.config.blueprints
- sails.config.bootstrap()
- sails.config.custom
- sails.config.datastores
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.security
- sails.config.session
- sails.config.sockets
- sails.config.views
-
Request (`req`)
- req._startTime
- req.body
- req.cookies
- req.fresh
- req.headers
- req.hostname
- req.ip
- req.ips
- req.isSocket
- req.method
- req.options
- req.originalUrl
- req.params
- req.path
- req.protocol
- req.query
- req.secure
- req.signedCookies
- req.socket
- req.subdomains
- req.url
- req.wantsJSON
- req.xhr
- req.accepts()
- req.acceptsCharsets()
- req.acceptsLanguages()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- req.setLocale()
- req.setTimeout()
- req.host
- Response (`res`)
- Waterline (ORM)
- WebSockets
Reference
Built with Love
The Sails framework is built by a web & mobile shop in Austin, TX, with the help of our contributors. We created Sails in 2012 to assist us on Node.js projects. Naturally we open-sourced it. We hope it makes your life a little bit easier!
© 2012-2025 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.