Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MAINTENANCE] Tiny update documentation and remove sphinx from docker compose #320

Merged
merged 2 commits into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions Documentation/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,29 +10,28 @@ dfgviewer* extension.
Installation
============

The current release 6.0 may be used with TYPO3 9.5 LTS or TYPO3 10.4 LTS.
The current release 6.1 may be used with TYPO3 10.4 or TYPO3 11.5 LTS.

The extension is based on `Kitodo.Presentation (dlf) <https://github.com/kitodo/kitodo-presentation>`_. Before you can start to
The extension is based on `Kitodo.Presentation (dlf) <https://github.com/kitodo/kitodo-presentation>`_ and `SLUB DigitalCollections (slub_digitalcollections) <https://github.com/slub/slub_digitalcollections>`. Before you can start to
use the *DFG Viewer (dfgviewer)* in your TYPO3 installation, you have to install
both extensions. The installation is only supported via Composer.
Kitodo.Presentation will be installed and configured automatically.

System Requirements
-------------------

You need a webserver stack with Apache2 or Ngnix, PHP >= 7.3 and MySQL / MariaDB.
Debian 10 (buster) is known to work with Kitodo.Presentation 3.2 and DFG-Viewer 5.2.
You need a webserver stack with Apache2 or Nginx, PHP >= 7.4 and MySQL / MariaDB.

We recommend at least:

* CPU: 1
* Memory: 2 GB
* Disk: 20 GB

Install a fresh TYPO3 9.5 LTS
Install a fresh TYPO3 11.5 LTS
-----------------------------

To install a fresh TYPO3 9.5 system, try the following installation procedure with composer::
To install a fresh TYPO3 11.5 system, try the following installation procedure with composer::

# Assuming the following settings:
# * the installation directory is /var/www/dfgviewer
Expand All @@ -43,7 +42,7 @@ To install a fresh TYPO3 9.5 system, try the following installation procedure wi
# remove /var/www/dfgviewer if it already exist or make sure it's really empty by ls -la dfgviewer/
rm -r dfgviewer/
# load full TYPO3 via composer
composer create-project typo3/cms-base-distribution:^9.5 dfgviewer
composer create-project typo3/cms-base-distribution:^11 dfgviewer
# Install the TYPO3 system with the TYPO3-console
cd dfgviewer/
./vendor/bin/typo3cms install:setup
Expand Down Expand Up @@ -83,7 +82,7 @@ You can set this easily with the TYPO3-console::

./vendor/bin/typo3cms configuration:set 'FE/pageNotFoundOnCHashError' 0

Now you have a working TYPO3 9.5 LTS installation and you can continue with composer
Now you have a working TYPO3 11.5 LTS installation and you can continue with composer
to install DFG-Viewer extension.


Expand All @@ -93,17 +92,18 @@ Install DFG-Viewer and Kitodo.Presentation via Composer
Composer commands::

# make sure you haven't set the platform php version to 7.2
composer config platform.php 7.3
composer config platform.php 7.4
# install DFG-Viewer extension
composer require slub/dfgviewer:^6.0
composer require slub/dfgviewer:^6.1

This will install the DFG-Viewer 6.0 extension and Kitodo.Presentation 4.0 from
This will install the DFG-Viewer 6.1 extension and Kitodo.Presentation 5.0 from
`Packagist <https://github.com/slub/dfg-viewer>`_.

Install the Extension via extension manager or CLI::

./vendor/bin/typo3 extension:activate dlf
./vendor/bin/typo3 extension:activate dfgviewer
./vendor/bin/typo3 extension:activate slub_digitalcollections

During the installation, three pages will be created: a root page, the "Kitodo
Configuration" folder and the viewer itself.
Expand Down
21 changes: 17 additions & 4 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,14 +57,27 @@
}
},
"scripts": {
"docs:setup": "./Build/Documentation/sphinx.sh install",
"docs:serve": "./Build/Documentation/sphinx.sh serve",
"docs:t3": "docker-compose -f ./Build/Documentation/docker-compose.t3docs.yml run --rm t3docs"
"docs:build": [
"rm -Rf ./Documentation-GENERATED-temp",
"docker run --user=$(id -u):$(id -g) --rm -v ./:/project -it ghcr.io/typo3-documentation/render-guides:latest --config ./Documentation",
"cp ./Build/Documentation/index.html ./Documentation-GENERATED-temp"
],
"docs:start": [
"docker run -d --name dlf_docs --rm -v ./Documentation-GENERATED-temp:/serve -p 9000:8000 jdkelley/simple-http-server:latest"
],
"docs:stop": [
"docker stop dlf_docs"
],
"docs:rebuild": [
"@composer docs:stop",
"@composer docs:build",
"@composer docs:start"
]
},
"config": {
"allow-plugins": {
"typo3/class-alias-loader": true,
"typo3/cms-composer-installers": true
}
}
}
}
Loading