Get Started with Server
This get-started guide follows the path for installing and configuring a single-machine Server and the associated, web-based Server. While this guide doesn't cover every setting and potential configuration, Server admins can follow this guide, leaving unmentioned settings in default states, to get a properly-configured, single-machine deployment of Server. For comprehensive help for Server admins, visit the Install, Configure, and Administer Server help pages.
This guide is for Server admins to get up and running quickly with an initial Server deployment. If you are a Server user, you can get started on the Use Server UI help page.
To install and run Server, your system has to have these prerequisites.
- Review the System Requirements for Server.
- Ensure the computer can contact the
whitelist.alteryx.comweb domain used by the Alteryx licensing system.
- Admin access to the host server's operating system or physical access to the server hardware.
- Read access to Active Directory, if you plan to use Integrated Windows Authentication Visit the Server Authentication help page to learn more about authentication options.
- Read and write permissions to the file share.
- Alteryx admin user.
We strongly recommend you to set Controller, Server UI, and Worker nodes to UTC time zone to keep the consistency between them.
- For new Server instances and installations, you can make sure that they all align.
- On existing systems, never adjust the time zone on the Controller or Server UI nodes.
Step 1. Download, Install, and License the Server
To get started, you need to download and install Server. Once installed, you need to activate a license for your Server instance.
Download, Install, and License How-To Article
Review the Install Server article for steps to download, install, and license Server.
Step 2. Configure System Settings
Once you have downloaded, installed, and licensed Server, you need to run through the System Settings to complete the Server setup. There are default system settings for all Server components. At a minimum, we recommend that you consider these components to ensure Server is configured correctly from the start:
- Server authentication method
- SMTP for Server email notifications
- Locations for log files to use for troubleshooting
System Settings How-To Articles
These articles cover the setup of these Server components. You can reference comprehensive configuration steps for all Server components in the System Settings articles.
Step 3. Set Up User Management
Once you have configured authentication, SMTP, and logging for your Server, you can begin adding users and user groups to your Server.
User and Group Management How-To Articles
These articles cover the critical user and group management steps. You can reference comprehensive user and group management help on the User and Group Management help page.
Step 4. Set Up Asset Management
Once your users and user groups are set up, you are ready to configure your Server for asset management.
Workflows and Insights How-To Articles
Start by adding workflows, insights, apps, and macros to your Server. Server users can save assets to the Server UI from Designer. As an admin, you can use this method as well, or you can add workflows from the Admin interface. Visit Workflows: Admin Interface for more info.
Collections How-To Articles
Next, create collections to allow users to share assets (workflows, apps, macros, and insights) with other Server users.
Schedules How-To Articles
Finally, schedule assets to run on a regular cadence in the Server.
Step 5. Set Up Credentials
Curators (Server admins) can save credentials to share with Server users to support access to directories and data.
Credentials How-To Articles
These articles cover the steps for managing credentials in your Server. You can reference comprehensive credential help on the Credentials help page.
Step 6. Set Up Data Connections
Curators (Server admins) can create Server data connections to allow Server users to connect to databases.