Skip to content
This repository has been archived by the owner on Nov 19, 2020. It is now read-only.

Commit

Permalink
NXBOOK-797 crossed link all sections in overview ot the chapters
Browse files Browse the repository at this point in the history
  • Loading branch information
mosabua committed Dec 19, 2014
1 parent ea64000 commit 9a6af1c
Show file tree
Hide file tree
Showing 6 changed files with 88 additions and 82 deletions.
12 changes: 7 additions & 5 deletions chapter-configuration.asciidoc
Expand Up @@ -207,6 +207,7 @@ left-hand Nexus menu.
Nexus provides for three different kinds of repositories: 'Proxy'
Repositories, 'Hosted' repositories, and 'Virtual' repositories.

[[proxy-repository]]
==== Proxy Repository

A 'Proxy Repository' is a proxy of a remote repository. By default,
Expand All @@ -227,6 +228,7 @@ the SSL secured version https://secure.central.sonatype.com/maven2/
preconfigured. Nexus OSS users and users of other repository managers
can purchase usage of the secured version for a nominal fee.

[[hosted-repository]]
==== Hosted Repository

A 'Hosted Repository' is a repository that is hosted by Nexus. Nexus
Expand Down Expand Up @@ -593,8 +595,8 @@ to 'True':
.Configuring Remote Repository Auto Block/Unblock
image::figs/web/configuring_auto-block.png[scale=75]

[[confignx-sect-managing-groups]]
=== Managing Groups
[[repository-groups]]
=== Managing Repository Groups

Groups are a powerful feature of Nexus. They allow you to combine
multiple repositories and other repository groups in a single URL. Use
Expand All @@ -606,7 +608,7 @@ combines the multiple important external proxy repositories like the
Central Repository with the hosted repositories: 3rd Party, Releases,
and Snapshots.

In <<maven-sect-single-group>> we configured Maven via the
In <<config-maven>> we configured Maven via the
settings.xml to look for artifacts in the public group managed by
Nexus. <<fig-group-config>> shows the group configuration screen in
Nexus. In this figure you can see the contents of the 'Public
Expand Down Expand Up @@ -1750,7 +1752,7 @@ and the plain text username and password cannot be stored in the
generated user tokens can be used instead.

User token usage is integrated in the Maven settings template feature of Nexus
documented in <<settings>> to further simplify its use.
documented in <<maven-settings>> to further simplify its use.

==== Enabling and Resetting User Tokens

Expand Down Expand Up @@ -1861,7 +1863,7 @@ curl -v --user HdeHuL4x:Y7ZH6ixZFdOVwNpRhaOV+phBISmipsfwVxPRUH1gkV09 http://loca
----

User token values can be accessed as part of the Maven settings
template feature automating updates as documented in <<settings>>.
template feature automating updates as documented in <<maven-settings>>.

NOTE: The user tokens are created at first access whether that is by
using the Nexus user interface or the Nexus Maven Plugin.
Expand Down
2 changes: 1 addition & 1 deletion chapter-installation.asciidoc
Expand Up @@ -854,7 +854,7 @@ support/:: The support zip archive documented in
<<support-tools>> is created and stored in this folder.

template-store/:: Contains the Maven settings template files
documented in detail in <<settings>>.
documented in detail in <<maven-settings>>.

timeline/:: Contains an index which Nexus uses to store events and
other information to support internal operations. Nexus uses this
Expand Down
150 changes: 77 additions & 73 deletions chapter-introduction.asciidoc
Expand Up @@ -56,37 +56,41 @@ components from remote repositories.

==== Nexus Open Source Features

Hosting Repositories:: When you host a repository with Nexus
Open Source, you can upload artifacts using the Nexus interface, or
you can deploy artifacts to hosted repositories using Maven. Nexus
will also create the standard Nexus Index for all of your hosted
repositories, which will allow tools like m2eclipse to rapidly locate
software artifacts for your developers.

Proxy Remote Repositories:: When you proxy a remote repository with
Nexus Open Source, you can control all aspects of the connection to a
remote repository, including security parameters, HTTP proxy
settings. You can configure from which mirrors Nexus will download,
how long Nexus will store artifacts, and how it will expire artifacts
which are no longer referenced by your build.

Repository Groups:: Grouping repositories allows you to consolidate
multiple repositories into a single URL. This makes configuring your
development environment very easy. All of your developers can point to
a single repository group URL, and if anyone ever needs a custom
remote repository added to the group, you can do this in a central
location without having to modify every developer’s workstation.
Hosting Repositories:: When you <<hosted-repository,host a
repository>> with Nexus Open Source, you can upload artifacts using
the Nexus interface, or you can deploy artifacts to hosted
repositories using Maven. Nexus will also create the standard Nexus
Index for all of your hosted repositories, which will allow tools like
m2eclipse to rapidly locate software artifacts for your developers.

Proxy Remote Repositories:: When you <<proxy-repository,proxy a remote
repository>> with Nexus Open Source, you can control all aspects of
the connection to a remote repository, including security parameters,
HTTP proxy settings. You can configure from which mirrors Nexus will
download, how long Nexus will store artifacts, and how it will expire
artifacts which are no longer referenced by your build.

Repository Groups:: <<repository-groups,Grouping repositories>> allows
you to consolidate multiple repositories into a single URL. This makes
configuring your development environment very easy. All of your
developers can point to a single repository group URL, and if anyone
ever needs a custom remote repository added to the group, you can do
this in a central location without having to modify every developer’s
workstation.

Numerous Repository Formats:: The concepts of hosted repositories,
proxy repositories and repository groups are supported for a number of
repository formats such as Maven 2, NuGet, NPM, RubyGems or YUM. This
allows you to facilitate one Nexus server to bring the same advantages
to all developers in a team relying on different technologies and
build tools tools including Apache Maven, Apache Ant, Gradle,
SBT, .Net, Node.js, Ruby and many others.
repository formats such as <<config-maven,Maven 2>>, <<nuget,NuGet>>,
<<npm,NPM>>, <<rubygems,RubyGems>> or <<yum,YUM>>. This allows you to
facilitate one Nexus server to bring the same advantages to all
developers in a team relying on different technologies and build tools
tools including <<config-maven,Apache Maven>>, Apache Ant with
<<ant-ivy,Apache Ivy>> or <<ant-aether,Eclipse Aether>>,
<<gradle,Gradle>>, <<sbt,SBT>>, <<nuget,.Net>>, <<npm,Node.js>>,
<<rubygems,Ruby>> and many others.

Hosting Project Web Sites:: Nexus is a publishing destination for
project web sites. While you very easily generate a project web site
<<sites,project web sites>>. While you very easily generate a project web site
with Maven, without Nexus, you will need to set up a WebDAV server and
configure both your web server and build with the appropriate security
credentials. With Nexus, you can deploy your project’s web site to the
Expand All @@ -95,36 +99,36 @@ destination for binaries and documentation helps to minimize the
number of moving parts in your development environment.

Fine-grained Security Model:: Nexus Open Source ships with a very
capable and customizable security model that can be used to configure
user interface as well as component access. Every operation in Nexus
is associated with a privilege, and privileges can be combined into
standard Nexus roles. Users can then be assigned both individual
privileges and roles that can be applied globally or at a fine-grained
level. You can create custom administrative roles that limit certain
repository actions, such as deployment to specific groups of
developers, and you can use these security roles to model the
structure of your organization.
<<security,capable and customizable security framework>> that can be
used to configure user interface as well as component access. Every
operation in Nexus is associated with a privilege, and privileges can
be combined into standard Nexus roles. Users can then be assigned both
individual privileges and roles that can be applied globally or at a
fine-grained level. You can create custom administrative roles that
limit certain repository actions, such as deployment to specific
groups of developers, and you can use these security roles to model
the structure of your organization.

Flexible LDAP Integration:: If your organization uses an LDAP server,
Nexus can integrate with an external authentication and access control
system. Nexus is smart enough to be able to automatically map LDAP
groups to the appropriate Nexus roles, and it also provides a very
flexible facility for mapping existing users and existing roles to
Nexus roles.
Nexus <<ldap,can integrate with an external authentication and access
control system>>. Nexus is smart enough to be able to automatically
map LDAP groups to the appropriate Nexus roles, and it also provides a
very flexible facility for mapping existing users and existing roles
to Nexus roles.

Component Search:: Nexus Open Source provides an intuitive search
feature which allows you to search for software components by
Component Search:: Nexus Open Source provides <<search-components,an intuitive
search feature>> which allows you to search for software components by
identifiers, such as groupId, artifactId, version, classifier, and
packaging, names of classes contained in Java archives, keywords, and
component sha1 checksums. In addition Nexus can
automatically download the index from remote repositories. This allows
discovery of components available in these remote repositories without
prior downloads.
component sha1 checksums. In addition Nexus can automatically download
the index from remote repositories. This allows discovery of
components available in these remote repositories without prior
downloads.

Scheduled Tasks:: Nexus Open Source has the concept of scheduled tasks:
periodic jobs which take care of various repository management tasks,
such as deleting old snapshots, evicting unused items, and publishing
repository indexes.
Scheduled Tasks:: Nexus Open Source has the <<scheduled-tasks,concept
of scheduled tasks>>: periodic jobs which take care of various
repository management tasks, such as deleting old snapshots, evicting
unused items, and publishing repository indexes.

REST Services:: Nexus Open Source is based on a series of REST
services, and when you are using the Nexus web front-end UI, you are
Expand Down Expand Up @@ -152,14 +156,14 @@ required to support the decision that go into making quality software.
Rich Component Information:: The Sonatype CLM data services provides
up-to-date and accurate information about known component security
vulnerabilities as well as license issues found by component source
inspection. This information is available in Nexus Professional and
helps your users with their component choice.
inspection. This information is <<component-info,available in Nexus
Professional>> and helps your users with their component choice.

Nexus Staging Suite:: When was the last time you did a software
release to a production system? Did it involve a QA team that had to
sign off on a particular build? What was the process you used to
re-deploy a new build if QA found a problem with the system at the
last minute? The Nexus Staging Suite provides workflow support for the
last minute? The <<staging,Nexus Staging Suite>> provides workflow support for the
release process of binary software components. If you need to create a
release component and deploy it to a hosted repository, you can use the
Staging Suite to post a collection of related, staged components which
Expand All @@ -169,38 +173,38 @@ be used to support the decisions that go into producing quality
software.

Support for OSGi Repositories:: Nexus Professional adds support for
OSGi Bundle repositories and P2 repositories for those developers who
<<osgi,OSGi Bundle repositories>> and <<p2,P2 repositories>> for those developers who
are targeting OSGi or the Eclipse platform. Just like you can proxy,
host, and group Maven 2, NuGet or NPM repositories with Nexus Open
Source, Nexus Professional allows you to do the same with OSGi
repositories.

Enterprise LDAP Support:: Nexus Professional offers LDAP support
Enterprise LDAP Support:: Nexus Professional offers <<ldap,LDAP support>>
features for enterprise LDAP deployments, including detailed
configuration of cache parameters, support for multiple LDAP servers
and backup mirrors, the ability to test user logins, support for
common user/group mapping templates, and the ability to support more
than one schema across multiple servers.

Support for Atlassian Crowd:: If your organization uses Atlassian
Crowd, Nexus Professional can delegate authentication and access
control to a Crowd server and map Crowd groups to the appropriate
Crowd, Nexus Professional can <<crowd,delegate authentication and
access control to a Crowd server>> and map Crowd groups to the appropriate
Nexus roles.

Maven Settings Management:: Nexus Professional along with the Nexus
M2Settings Maven Plugin allows you to manage Maven settings. Once you
have developed a Maven Settings template, developers can then connect
to Nexus Professional using the Nexus M2Settings Maven plugin which
will take responsibility for downloading a Maven settings file from
Nexus and replacing the existing Maven settings on a local
workstation.
M2Settings Maven Plugin allows you to <<maven-settings,manage Maven
settings>>. Once you have developed a Maven Settings template,
developers can then connect to Nexus Professional using the Nexus
M2Settings Maven plugin which will take responsibility for downloading
a Maven settings file from Nexus and replacing the existing Maven
settings on a local workstation.

Custom Repository Metadata:: Nexus Professional provides a facility
for user-defined, custom metadata. If you need to keep track of custom
attributes to support approval workflow or to associate custom
identifiers with software artifacts, you can use Nexus to define and
manipulate custom attributes which can be associated with artifacts in
a Nexus repository.
for user-defined <<custom-metadata-plugin,custom metadata>>. If you
need to keep track of custom attributes to support approval workflow
or to associate custom identifiers with software artifacts, you can
use Nexus to define and manipulate custom attributes which can be
associated with artifacts in a Nexus repository.

=== Nexus Professional CLM Edition

Expand All @@ -216,12 +220,12 @@ define component usage policies in terms of security vulnerabilities,
license issues and many other characteristics of the used components.

Release Policy Enforcement:: The Nexus Staging Suite can be configured
to use application-specific policies for automated release validation.
to use <<staging-clm,application-specific policies for automated release validation>>.

Application Specific Component Information:: The component information
displayed in Nexus can take the application-specific policies of your
organization into account and display the specific validation result
to the users.
Application Specific Component Information:: The
<<component-info,component information>> displayed in Nexus can take
the application-specific policies of your organization into account
and display the specific validation result to the users.

////
/* Local Variables: */
Expand Down
2 changes: 1 addition & 1 deletion chapter-maven-settings.asciidoc
@@ -1,4 +1,4 @@
[[settings]]
[[maven-settings]]
== Managing Maven Settings

[[settings-sect-intro]]
Expand Down
2 changes: 1 addition & 1 deletion chapter-maven.asciidoc
Expand Up @@ -17,7 +17,7 @@ this up is documented in the chapter in addition to the configuration
used by specific tools.


[[maven-sect-single-group]]
[[config-maven]]
=== Apache Maven

To use Nexus with http://maven.apache.org/[Apache Maven], we configure
Expand Down
2 changes: 1 addition & 1 deletion chapter-rubygems.asciidoc
Expand Up @@ -121,7 +121,7 @@ allows you to expose the aggregated content of multiple proxy and
hosted Gem repositories with one URL to +gem+ and other tools. This
is possible for Gem repositories by creating a new 'Repository Group'
with the 'Provider' set to +Rubygems+ as documented in
<<confignx-sect-managing-groups>>.
<<repository-groups>>.

A typical, useful example would be to group the proxy repository that
proxies the RubyGems repository, a hosted Gem repository with
Expand Down

0 comments on commit 9a6af1c

Please sign in to comment.