Welcome on the Nuxeo Server tutorials.
The goal of this section is to provide ready to use examples. They can be followed step by step to learn how to configure Nuxeo Server on practical use cases. The section also aims at providing solutions to commonly encountered situations.
Hyland University
Development
DevTools
| Title | Excerpt | Level |
|---|---|---|
| HOWTO: Develop Faster with Git and Your Nuxeo Studio Project | Learn how to synchronize your Studio sources with a local instance and to make the development process of custom elements | Advanced |
| HOWTO: Work with Maven Integration | Learn how to integrate your Studio project with Maven | Advanced |
Develop a Custom Addon
| Title | Excerpt | Level |
|---|---|---|
| Deploy and Publish | Learn how to package, publish, deploy and hotreload a project. | Intermediate |
| Develop Your Own Java Code | Learn how to start working with Nuxeo CLI. | Intermediate |
| HOWTO: Create an Empty Bundle | Learn the basics of a Nuxeo module raw creation. | Advanced |
| HOWTO: Customize Document Validation | Leans how to customize the document validation error messages and how to add new references validation on document types. | Advanced |
| HOWTO: Define a Runtime XMap Object | Learn how to annotate a POJO class as a Runtime Contribution | Advanced |
| HOWTO: Unit Test a Studio Bundle | Learn how to unit test a Studio Bundle | Advanced |
| HOWTO: Use the Runtime Java API | Learn how to use the Runtime Java API. | Advanced |
| HOWTO: Use the Trash Feature | Learn how to use the trash feature in Nuxeo Platform. | Advanced |
| HOWTO: Write a Bundle Manifest | Learn how to write a Bundle Manifest. | Advanced |
REST API
| Title | Excerpt | Level |
|---|---|---|
| HOWTO: Contribute to the REST API | Learn how to contribute to the REST API. | Advanced |
| HOWTO: Develop with Angular2 | Learn how to develop with Angular2. | Advanced |
| HOWTO: Upload a File in Nuxeo Using REST API | Learn how to import a file using the Batch processing endpoint of the REST API. | Advanced |
| HOWTO: Use the Trash Feature | Learn how to use the trash feature in Nuxeo Platform. | Advanced |
| Query Endpoint (Deprecated) | This how-to provides an example of how to use the REST API to query the Nuxeo repository. | Advanced |
Architecture and Administration
Nuxeo Server Configuration
| Title | Excerpt | Level |
|---|---|---|
| HOWTO: Change Context Path | The Nuxeo Platform offers the capability to change the context path, i.e. /nuxeo in the URL of your application. | Intermediate |
| HOWTO: Configure Web UI Global Settings | Learn how to configure global Web UI settings. | Advanced |
| How to Estimate Volume Usage | Get some guidelines to estimate the required size for disk and database. | Intermediate |
Users and Groups
| Title | Excerpt | Level |
|---|---|---|
| How to Add Custom LDAP Fields to the UI | Learn how to add a custom LDAP fields to the User interface using XML extensions. | Advanced |
| How to Configure a Multidirectory for Users and Groups | This page provides a turnkey solution to configure a multidirectory. | Intermediate |
| How to Contribute a New "User Registration Request" Document Type | Learn how to contribute new request types to the addon. | Intermediate |
| How to Define Public Pages (Viewable by Anonymous Users) | Learn how to make some pages visible by anonymous users. | Advanced |
| How to Enable Quotas on Document Types | Learn how to enable Nuxeo Quota features on document types other than domains and workspaces. | Beginner |
Elasticsearch Configuration
| Title | Excerpt | Level |
|---|---|---|
| HOWTO: Expose Elasticsearch Hint as Extension Point | Learn how to expose Elasticsearch hints as extention points. | Advanced |
Deployment
| Title | Excerpt | Level |
|---|---|---|
| Deploy and Publish | Learn how to package, publish, deploy and hotreload a project. | Intermediate |
| Develop Your Own Java Code | Learn how to start working with Nuxeo CLI. | Intermediate |
| HOWTO: Deploy Web UI Within a Nuxeo Server | Learn how to deploy Web UI within a Nuxeo server. | Advanced |
| HOWTO: Deploy Your Project in Dev Mode | Learn How to Deploy a Nuxeo Studio release | Beginner |
| HOWTO: Develop Faster with Git and Your Nuxeo Studio Project | Learn how to synchronize your Studio sources with a local instance and to make the development process of custom elements | Advanced |
| HOWTO: Export a Studio Project in Eclipse | Learn how to import Studio files in Eclipse | Advanced |
| HOWTO: Install the Studio JAR Manually | Learn How to Install the Studio JAR Manually | Intermediate |
| HOWTO: Unit Test a Studio Bundle | Learn how to unit test a Studio Bundle | Advanced |
| HOWTO: Work with Maven Integration | Learn how to integrate your Studio project with Maven | Advanced |