diff --git a/modules/ROOT/images/icon-admin.svg b/modules/ROOT/images/icon-admin.svg new file mode 100644 index 000000000..e7ed8a215 --- /dev/null +++ b/modules/ROOT/images/icon-admin.svg @@ -0,0 +1,12 @@ + + + + + + + + + + + + diff --git a/modules/ROOT/images/icon-cheatsheet.svg b/modules/ROOT/images/icon-cheatsheet.svg new file mode 100644 index 000000000..22e66b098 --- /dev/null +++ b/modules/ROOT/images/icon-cheatsheet.svg @@ -0,0 +1,4 @@ + + + + diff --git a/modules/ROOT/images/icon-dbsettings.svg b/modules/ROOT/images/icon-dbsettings.svg new file mode 100644 index 000000000..b5072daad --- /dev/null +++ b/modules/ROOT/images/icon-dbsettings.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/modules/ROOT/images/icon-developer.svg b/modules/ROOT/images/icon-developer.svg new file mode 100644 index 000000000..a6af03229 --- /dev/null +++ b/modules/ROOT/images/icon-developer.svg @@ -0,0 +1,6 @@ + + + + + + diff --git a/modules/ROOT/images/icon-import.svg b/modules/ROOT/images/icon-import.svg new file mode 100644 index 000000000..f012fad01 --- /dev/null +++ b/modules/ROOT/images/icon-import.svg @@ -0,0 +1,12 @@ + + + + + + + + + + + + diff --git a/modules/ROOT/images/icon-library.svg b/modules/ROOT/images/icon-library.svg new file mode 100644 index 000000000..f2d0beac4 --- /dev/null +++ b/modules/ROOT/images/icon-library.svg @@ -0,0 +1,4 @@ + + + + diff --git a/modules/ROOT/images/icon-server.svg b/modules/ROOT/images/icon-server.svg new file mode 100644 index 000000000..d799cd840 --- /dev/null +++ b/modules/ROOT/images/icon-server.svg @@ -0,0 +1,3 @@ + + + diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index 3e6ac990f..d78d872b7 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -1,5 +1,12 @@ [[operations-manual]] -= The Neo4j Operations Manual += Neo4j Operations +:page-layout: docs-ndl +:page-theme: docs +:page-role: hub +:page-show-home-link: true +:page-hide-nav-title: true +// :page-disablefeedback: true +:page-toclevels: -1 :neo4j-buildnumber: {neo4j-version} :download-center-uri: https://neo4j.com/deployment-center/ :lucene-version: 5_4_0 @@ -8,26 +15,122 @@ :console: 0 -This is the Neo4j Operations Manual, which includes all the operational details and instructions for installing and deploying Neo4j on-premise and in the cloud. +Neo4j Operations includes all the operational details and instructions for installing, deploying, and operating Neo4j in a self-managed environment. -For all information on *upgrading and migrating Neo4j*, see the link:{neo4j-docs-base-uri}/upgrade-migration-guide/current/[Neo4j Upgrade and Migration Guide]. +The latest version of Neo4j is *{neo4j-version-exact}*. -For more information on link:https://neo4j.com/aura/[Aura], the Neo4j fully managed cloud service, see the link:{neo4j-docs-base-uri}/aura[Neo4j Aura Manual]. +[.display.cards] +== References +=== How-tos and tutorials -The latest version of Neo4j is *{neo4j-version-exact}*. +[.icon] +image:icon-library.svg[] + +[.list] +* xref:tutorial/neo4j-admin-import.adoc[Neo4j-admin import] +* xref:clustering/setup/deploy.adoc[Deploy a basic cluster] +* xref:clustering/setup/analytics-cluster.adoc[Deploy an analytics cluster] +* xref:/clustering/setup/discovery.adoc[Move from discovery service v1 to v2] +* xref:/clustering/disaster-recovery.adoc[Disaster recovery guide] +* xref:tutorial/access-control.adoc[Fine-grained access control] +* xref:tutorial/tutorial-composite-database.adoc[Set up and use a composite database] +* xref:tutorial/tutorial-sso-configuration.adoc[Configure Neo4j Single Sign-On (SSO)] +* xref:docker/docker-compose-standalone.adoc[Deploy Neo4j using Docker Compose] +* xref:tutorial/tutorial-clustering-docker.adoc[Deploy a cluster in a Docker container] +* xref:kubernetes/quickstart-standalone/index.adoc[Deploy Neo4j using Helm charts] +* xref:kubernetes/quickstart-cluster/index.adoc[Deploy a cluster using Helm charts] +* xref:kubernetes/quickstart-analytics-cluster.adoc[Deploy an analytical cluster using Helm charts] + +=== Cheet sheets + +[.icon] +image:icon-cheatsheet.svg[] + +[.list] +* xref:/configuration/configuration-settings.adoc[Configuration settings] +* xref:procedures.adoc[Procedures] +* xref:/monitoring/metrics/index.adoc[Metrics] +* xref:/database-administration/syntax.adoc[Database management commands syntax] +* xref:/clustering/server-syntax.adoc[Server management commands syntax] +* xref:/docker/ref-settings.adoc[Docker configuration settings conversion table] +* xref:/configuration/ports.adoc[Ports in Neo4j] +* xref:/tools/neo4j-admin/index.adoc[Neo4j Admin and Neo4j CLI] +* xref:changes-deprecations-removals.adoc[Changes, deprecations, and removals] + +=== Cypher admin commands + +[.icon] +image:icon-developer.svg[] + +[.list] +* xref:database-administration/standard-databases/naming-databases.adoc[Manage standard databases] +* xref:database-administration/aliases/naming-aliases.adoc[Manage database aliases] +* xref:database-administration/composite-databases/concepts.adoc[Manage composite databases] +* xref:clustering/servers.adoc[Manage servers in a cluster] +* xref:clustering/databases.adoc[Manage databases in a cluster] +* xref:authentication-authorization/manage-users.adoc[Manage users] +* xref:authentication-authorization/manage-roles.adoc[Manage roles] +* xref:authentication-authorization/manage-privileges.adoc[Manage privileges] +* xref:authentication-authorization/built-in-roles.adoc[Built-in roles and privileges] +* xref:authentication-authorization/immutable-roles-privileges.adoc[Manage immutable roles and privileges] + + +[.display.cards] +== Neo4j Admin commands + +=== DBMS and server commands + +[.icon] +image:icon-server.svg[] + +[.list] +* xref:configuration/set-initial-password.adoc[`neo4j-admin dbms set-initial-password`] +* `neo4j-admin dbms set-default-admin` +* `neo4j-admin dbms unbind-system-db` +// * `neo4j-admin server console` +// * `neo4j-admin server get-id` +// * `neo4j-admin server license` +* xref:tools/neo4j-admin/neo4j-admin-memrec.adoc[`neo4j-admin server memory-recommendation`] +* xref:tools/neo4j-admin/migrate-configuration.adoc[`neo4j-admin server migrate-configuration`] +* xref:tools/neo4j-admin/neo4j-admin-report.adoc[`neo4j-admin server report`] +// * `neo4j-admin server restart` +// * `neo4j-admin server start` +// * `neo4j-admin server status` +// * `neo4j-admin server stop` +* xref:tools/neo4j-admin/unbind.adoc[`neo4j-admin server unbind`] +* xref:/tools/neo4j-admin/validate-config.adoc[`neo4j-admin server validate-config`] +* `neo4j-admin server windows-service` + +=== Database commands + +[.icon] +image:icon-dbsettings.svg[] + +[.list] +* xref:tools/neo4j-admin/consistency-checker.adoc[`neo4j-admin database check`] +* xref:tools/neo4j-admin/neo4j-admin-store-info.adoc[`neo4j-admin database info`] +* xref:tools/neo4j-admin/neo4j-admin-import.adoc[`neo4j-admin database import`] +* xref:tools/neo4j-admin/upload-to-aura.adoc[`neo4j-admin database upload`] +* xref:tools/neo4j-admin/migrate-database.adoc[`neo4j-admin database migrate`] +* xref:backup-restore/copy-database.adoc[`neo4j-admin database copy`] + +=== Database backup commands + +[.icon] +image:icon-import.svg[] -ifdef::backend-pdf[] -include::license.adoc[leveloffset=+1] -endif::[] +[.list] +* xref:backup-restore/online-backup.adoc[`neo4j-admin database backup`] +* xref:backup-restore/aggregate.adoc[`neo4j-admin backup aggregate`] +* xref:backup-restore/inspect.adoc[`neo4j-admin backup inspect`] +* xref:backup-restore/restore-backup.adoc[`neo4j-admin database restore`] +* xref:backup-restore/offline-backup.adoc[`neo4j-admin database dump`] +* xref:backup-restore/restore-dump.adoc[`neo4j-admin database load`] -ifdef::backend-html5[(C) {copyright}] -ifndef::backend-pdf[] -Documentation license: link:{common-license-page-uri}[Creative Commons 4.0] -endif::[] -ifdef::backend-pdf[] -(C) {copyright} +[.next-steps] +== Licenses and disclaimers -Documentation license: <> -endif::[] \ No newline at end of file +[.link] +link:https://neo4j.com/docs/license[Licenses and disclaimers] \ No newline at end of file