Skip to content

Commit

Permalink
fixes, corrections and improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
mmattel committed Jun 14, 2024
1 parent 530af61 commit b619734
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 46 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ toc::[]

== Introduction

{description} The aim of this guide is to be up and running as fast as possible using a deployment setup that includes Infinite Scale and web office applications for document collaboration. Using this setup, you can get a feeling about the capabilities of Infinite Scale. Based on this guide, you can later adjust for other requirements not handled in this documentation.
{description} The aim of this guide is to be up and running as fast as possible using a setup that includes *Infinite Scale and web office applications for document collaboration* optimized for evaluation. Using this setup, you can get a feeling about the capabilities of Infinite Scale. Based on this guide, you can later adjust for other requirements not handled in this documentation.

NOTE: This guide references the latest stable downloadable version of this release of Infinite Scale.

Expand All @@ -24,7 +24,7 @@ NOTE: This guide references the latest stable downloadable version of this relea

This guide describes an installation of Infinite Scale based on Ubuntu LTS and docker compose. The underlying hardware of the computer (server) can be anything as listed below as long it meets the OS requirements defined in the xref:software-stack[Software Stack]:

* Raspberry Pi
* Raspberry Pi (4 and higher, min. 8GB RAM)
* Notebook
* PC
* Virtual Machine
Expand Down Expand Up @@ -82,7 +82,7 @@ Accessing Infinite Scale::
+
Setting up access from the outside, aka internet, to the server using an external resolvable domain like `ocis.mydomain.com` and routing networks ([.red]#red#) is *not* part of this documentation but can be configured.
+
image::depl-examples/ubuntu-compose/ubuntu-test-install.drawio.svg[Network Overview, width=400]
image::depl-examples/ubuntu-compose/ubuntu-eval-install.drawio.svg[Network Overview, width=400]

. To access Infinite Scale from your computer or from your local network, the domain name `ocis.owncloud.test` and other required subdomains are used which are not resolvable from external networks.

Expand All @@ -96,8 +96,11 @@ The following embedded services are well suited for this kind of installation an
* Infinite Scale has an embedded identity management (IDM footnote:[See the xref:{s-path}/idm.adoc[IDM, window=_blank] service for more details]) which takes care of creating, storing, and managing user identity information.
* In addition, it also has an embedded identity provider (IDP footnote:[See the xref:{s-path}/idp.adoc[IDP, window=_blank] service for more details]) to track and manage user identities, as well as the permissions and access levels associated with those identities.

== Install the Docker Engine
== Install Docker and Docker Compose

Docker Engine::
+
--
To check if docker is installed, open a shell and type the following command:

[source,bash]
Expand All @@ -114,6 +117,10 @@ https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository[Inst
Check with the verification step to see if docker has been installed successfully.

Note that by default and for security reasons, docker commands need to be issued with `sudo` permissions. You can change that based on the description in https://docs.docker.com/engine/install/linux-postinstall/[Manage Docker as a non-root user, window=_blank]. You need to understand and take responsibility for the different security situation when Docker is used as a non-root user.
--

Docker Compose::
To install `docker compose` follow the docker guide in https://docs.docker.com/compose/install/linux/#install-the-plugin-manually[Install the Compose plugin, window=_blank].

== Prepare the Infinite Scale Installation

Expand Down Expand Up @@ -235,8 +242,11 @@ This command will download all necessary containers and starts up the instance a

=== Prepare Your Browser

IMPORTANT: Because no valid browser certificates are used, this setup should never run in production and is intended for evaluation only.

* The following step is necessary because no valid browser certificates like ones from Letsencrypt are used.
* When using trusted certificates which require a domain resolvable from the internet, this step is not necessary. Setting up trusted certificates is not covered here.

* When using trusted certificates like with Letsencrypt which require a domain resolvable from the internet, this step is not necessary. Setting up trusted certificates is not covered here.

After you have started up Infinite Scale, you must accept per browser invalid certificates provided by the docker compose setup *before* you can access Infinite Scale and web office applications.

Expand Down Expand Up @@ -391,14 +401,14 @@ sudo docker compose ps --format "table {{.Service}}\t{{.State}}"

Follow this guide if you have finished testing and would like to fully remove the instance including all data.

. Shut down the docker compose environment:
. Shut down the docker compose environment and remove all volumes declared in the "volumes" section of the Compose file and anonymous volumes attached to containers:
+
--
Change into the `ocis_wopi` directory and issue:

[source,bash]
----
sudo docker compose down
sudo docker compose down -v
----
--

Expand Down Expand Up @@ -435,45 +445,7 @@ sudo docker images
--
[source,bash]
----
sudo docker rmi <container ID> <container ID> ...
----
--

. Remove docker volumes:
** Remove all unused anonymous docker volumes:
+
--
[source,bash]
----
sudo docker volume prune
----
--

** Remove all named docker volumes related to this deployment:
*** First list all remaining docker volumes:
+
--
[source,bash]
----
sudo docker volume ls
----
--

*** Then remove all volumes starting with `ocis_wopi_`
+
--
[source,bash]
----
sudo docker volume rm <volume name> <volume name> ...
----
--

*** Finally check if all of them have been removed:
+
--
[source,bash]
----
sudo docker volume ls
sudo docker rmi <image ID> <image ID> ...
----
--

Expand Down

0 comments on commit b619734

Please sign in to comment.