Installation Guide
Before you write the first line of code with TX Text Control .NET Server 34.0, a few things need to be in place: the system requirements, the NuGet and npm packages, the license in your project and a way to update to a new service pack or version. The Installation Guide walks through them for developers who set up a development machine, a project or a build pipeline.
If you want to build an application right away, start with Getting Started. The tutorials there link back to the pages in this guide when you need details.
Licensed or Evaluating: How You Get the Packages
TX Text Control .NET Server is added to your projects as NuGet packages. Where these packages come from depends on whether you have a license or are evaluating the product:
| Text Control Private NuGet Feed | Trial setup | |
|---|---|---|
| Who uses it | Developers with a license who have a serial number assigned to them | Developers who evaluate the product |
| How you set it up | No setup to install. You add a personal nuget.config file to your project and install the packages with Visual Studio or the .NET CLI. | The Windows setup TX Text Control.NET Server 34.0 Trial.exe. It installs the product and a local NuGet package source named Text Control Offline Packages. |
| License | Injected into each package on the server before the download | Trial version, fully featured and valid for 30 days |
| Limits | You only see the packages you are licensed for. | Evaluation only |
Licensed developers get a personal nuget.config file when a serial number is assigned to them and install the packages from the package source TextControl; Get Started in Three Steps shows the setup. Developers who evaluate the product install the trial version and select Text Control Offline Packages as the package source; Evaluating with the Trial Version lists what the license agreement forbids for the trial version. For questions about buying a license, contact the Text Control sales team.
The Installation Path
Work through the guide in this order:
- Check the system requirements. The NuGet packages of the Core and Classic engines require .NET 8 or higher. Check the operating systems for development and deployment, your development tools and, for the Document Editor and Document Viewer, your users' browsers. See System Requirements.
- Choose the packages. Pick an engine: Core (
TXTextControl.TextControl.Core.SDK) runs on Windows and Linux and is recommended for new projects. Classic (TXTextControl.TextControl.ASP.SDK) runs on Windows only and is needed for the legacy Word binary format (DOC). Add the packages for the Document Editor or Document Viewer if your application uses them. See NuGet Packages. - Add npm packages for Angular or React. If your frontend is an Angular or React application, install the npm packages. Angular and React frontends need an ASP.NET Core backend with TX Text Control .NET Server. See npm Packages.
- Configure your licenses. Every developer who uses the product needs an assigned developer license. Production servers need runtime licenses. See License Configuration.
- Stay up to date. Update the packages when a service pack or a new version is released, and check the breaking changes. See Upgrade Guide.
Find the Right Page
| If you want to | Read |
|---|---|
| Check which .NET versions, operating systems, tools and browsers are supported | System Requirements |
| Find out which NuGet package you need for which task | Package Overview |
| Create or renew an API token for the private feed | Creating an API Token |
Set up nuget.config in a project | nuget.config |
| Install packages in Visual Studio or with the .NET CLI | Visual Studio, .NET CLI |
| Use the packages installed by the trial setup | Offline Packages |
| Understand how package versions relate to service packs | Package Versioning |
| Add the Document Editor or Document Viewer to Angular or React | npm Packages |
| Learn how your development license reaches your project | Development Licenses |
| Prepare a deployment to production servers | Runtime Licenses |
| Move an existing application to version 34.0 | Migrating from Previous Versions |
After Installation
- Getting Started: step-by-step tutorials for your first application.
- Deployment Guide: run your application on Windows, Linux, Docker and in the cloud.
- NuGet Authentication: what to check when the private feed does not return packages.