diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index be469dc888e..c03135b37bf 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -14,7 +14,7 @@ name: "CodeQL" on: push: pull_request: - branches: [ master ] + branches: [ main ] # Allows you to run this workflow manually from the Actions tab workflow_dispatch: diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index e4b88c595b8..d3f54021dee 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -4,10 +4,10 @@ name: CI # Controls when the action will run. on: - # Triggers the workflow on push and pull request events but only for pull_requests on the master branch + # Triggers the workflow on push and pull request events but only for pull_requests on the main branch push: pull_request: - branches: [ master ] + branches: [ main ] # Allows you to run this workflow manually from the Actions tab workflow_dispatch: diff --git a/Kitodo/src/main/resources/kitodo_config.properties b/Kitodo/src/main/resources/kitodo_config.properties index 9fe425ec510..eb22ba64d44 100644 --- a/Kitodo/src/main/resources/kitodo_config.properties +++ b/Kitodo/src/main/resources/kitodo_config.properties @@ -591,7 +591,7 @@ taskProcessPropertyColumns= # - the activeMQ.hostURL should use the ssl:// procotocol at least once # - you must provide the JKS keystore (file or URI) including the keystore password # - you must provide the JKS truststore (file or URI) including the truststore password -# See https://github.com/kitodo/kitodo-production/tree/master/docs/gettingstarted/use_secured_activemq.md for +# See https://github.com/kitodo/kitodo-production/tree/main/docs/gettingstarted/use_secured_activemq.md for # more information how to generate certificats and how to configure the ActiveMQ server side #activeMQ.useSSL = false #activeMQ.keyStore = /usr/local/kitodo/certs/activemq-client.ks @@ -600,7 +600,7 @@ taskProcessPropertyColumns= #activeMQ.trustStorePassword = # Define if an authentication and authorization should be used. If so a username and password must be provided -# See https://github.com/kitodo/kitodo-production/tree/master/docs/gettingstarted/use_secured_activemq.md for +# See https://github.com/kitodo/kitodo-production/tree/main/docs/gettingstarted/use_secured_activemq.md for # more information how to configure the authentification and authorization #activeMQ.useAuth = false #activeMQ.authUsername = diff --git a/docs/README.md b/docs/README.md index a13cb18f45b..32c27d47dfc 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # Kitodo.Production Developer Documentation * Read the docs: -* GitHub: +* GitHub: This documentation is work in progress. Please consult the [javadoc](javadoc/README.md) or [contact the developer team](https://maillist.slub-dresden.de/cgi-bin/mailman/listinfo/kitodo-developer) if you have specific questions that are not covered here yet. diff --git a/docs/developer/gettingstarted/development-version.md b/docs/developer/gettingstarted/development-version.md index 57ea85a36da..82b482d5f41 100644 --- a/docs/developer/gettingstarted/development-version.md +++ b/docs/developer/gettingstarted/development-version.md @@ -45,11 +45,11 @@ sudo sed -i 's/securerandom.source=file:\/dev\/random/securerandom.source=file:\ ### Build development version and modules ``` -wget https://github.com/kitodo/kitodo-production/archive/master.zip -unzip master.zip && rm master.zip -(cd kitodo-production-master/ && mvn clean package '-P!development') -zip -j kitodo-3-modules.zip kitodo-production-master/Kitodo/modules/*.jar -mv kitodo-production-master/Kitodo/target/kitodo-3*.war kitodo-3.war +wget https://github.com/kitodo/kitodo-production/archive/main.zip +unzip main.zip && rm main.zip +(cd kitodo-production-main/ && mvn clean package '-P!development') +zip -j kitodo-3-modules.zip kitodo-production-main/Kitodo/modules/*.jar +mv kitodo-production-main/Kitodo/target/kitodo-3*.war kitodo-3.war ``` Note: If you want to build a release version, you may want to set the version in pom.xml files before packaging @@ -63,9 +63,9 @@ sudo mysql -e "create database kitodo;grant all privileges on kitodo.* to kitodo ### Generate SQL dump (flyway migration) ``` -cat kitodo-production-master/Kitodo/setup/schema.sql | mysql -u kitodo -D kitodo --password=kitodo -cat kitodo-production-master/Kitodo/setup/default.sql | mysql -u kitodo -D kitodo --password=kitodo -(cd kitodo-production-master/Kitodo-DataManagement && mvn flyway:baseline -Pflyway && mvn flyway:migrate -Pflyway) +cat kitodo-production-main/Kitodo/setup/schema.sql | mysql -u kitodo -D kitodo --password=kitodo +cat kitodo-production-main/Kitodo/setup/default.sql | mysql -u kitodo -D kitodo --password=kitodo +(cd kitodo-production-main/Kitodo-DataManagement && mvn flyway:baseline -Pflyway && mvn flyway:migrate -Pflyway) mysqldump -u kitodo --password=kitodo kitodo > kitodo-3.sql ``` @@ -73,11 +73,11 @@ mysqldump -u kitodo --password=kitodo kitodo > kitodo-3.sql ``` mkdir zip zip/config zip/debug zip/import zip/logs zip/messages zip/metadata zip/plugins zip/plugins/command zip/plugins/import zip/plugins/opac zip/plugins/step zip/plugins/validation zip/rulesets zip/scripts zip/swap zip/temp zip/users zip/xslt zip/diagrams -install -m 444 kitodo-production-master/Kitodo/src/main/resources/kitodo_*.xml zip/config/ -install -m 444 kitodo-production-master/Kitodo/src/main/resources/docket*.xsl zip/xslt/ -install -m 444 kitodo-production-master/Kitodo/rulesets/*.xml zip/rulesets/ -install -m 444 kitodo-production-master/Kitodo/diagrams/*.xml zip/diagrams/ -install -m 554 kitodo-production-master/Kitodo/scripts/*.sh zip/scripts/ +install -m 444 kitodo-production-main/Kitodo/src/main/resources/kitodo_*.xml zip/config/ +install -m 444 kitodo-production-main/Kitodo/src/main/resources/docket*.xsl zip/xslt/ +install -m 444 kitodo-production-main/Kitodo/rulesets/*.xml zip/rulesets/ +install -m 444 kitodo-production-main/Kitodo/diagrams/*.xml zip/diagrams/ +install -m 554 kitodo-production-main/Kitodo/scripts/*.sh zip/scripts/ chmod -w zip/config zip/import zip/messages zip/plugins zip/plugins/command zip/plugins/import zip/plugins/opac zip/plugins/step zip/plugins/validation zip/rulesets zip/scripts zip/xslt (cd zip && zip -r ../kitodo-3-config.zip *) ``` @@ -191,9 +191,9 @@ Menu System: ### Download sources ``` -rm -rf kitodo-production-master -wget https://github.com/kitodo/kitodo-production/archive/master.zip -unzip master.zip && rm master.zip +rm -rf kitodo-production-main +wget https://github.com/kitodo/kitodo-production/archive/main.zip +unzip main.zip && rm main.zip ``` ### Reset database @@ -201,26 +201,26 @@ unzip master.zip && rm master.zip ``` sudo mysql -e "drop database kitodo;" sudo mysql -e "create database kitodo;grant all privileges on kitodo.* to kitodo@localhost identified by 'kitodo';flush privileges;" -cat kitodo-production-master/Kitodo/setup/schema.sql | mysql -u kitodo -D kitodo --password=kitodo -cat kitodo-production-master/Kitodo/setup/default.sql | mysql -u kitodo -D kitodo --password=kitodo -(cd kitodo-production-master/Kitodo-DataManagement && mvn flyway:baseline -Pflyway && mvn flyway:migrate -Pflyway) +cat kitodo-production-main/Kitodo/setup/schema.sql | mysql -u kitodo -D kitodo --password=kitodo +cat kitodo-production-main/Kitodo/setup/default.sql | mysql -u kitodo -D kitodo --password=kitodo +(cd kitodo-production-main/Kitodo-DataManagement && mvn flyway:baseline -Pflyway && mvn flyway:migrate -Pflyway) ``` ### Rebuild and deploy war file ``` -(cd kitodo-production-master/ && mvn clean package '-P!development') +(cd kitodo-production-main/ && mvn clean package '-P!development') sudo rm -f /usr/local/kitodo/modules/* -sudo cp kitodo-production-master/Kitodo/modules/*.jar /usr/local/kitodo/modules +sudo cp kitodo-production-main/Kitodo/modules/*.jar /usr/local/kitodo/modules sudo chown -R tomcat8:tomcat8 /usr/local/kitodo/modules -mv kitodo-production-master/Kitodo/target/kitodo-3*.war kitodo-3.war +mv kitodo-production-main/Kitodo/target/kitodo-3*.war kitodo-3.war sudo chown tomcat8:tomcat8 kitodo-3.war sudo mv kitodo-3.war /var/lib/tomcat8/webapps/kitodo.war sleep 5 until curl -s GET "localhost:8080/kitodo/pages/login.jsf" | grep -q -o "KITODO.PRODUCTION" ; do sleep 1; done ``` -Note: If the update provides new example data, it has to be copied from kitodo-production-master/Kitodo/... to /usr/local/kitodo/... manually. +Note: If the update provides new example data, it has to be copied from kitodo-production-main/Kitodo/... to /usr/local/kitodo/... manually. ### Reset index diff --git a/docs/developer/guidelines/README.md b/docs/developer/guidelines/README.md index 9079dbd713b..ca13a26648f 100644 --- a/docs/developer/guidelines/README.md +++ b/docs/developer/guidelines/README.md @@ -22,4 +22,4 @@ * Unterscheidung bezieht sich auf die GitHub Projekte [Kitodo.ContentServer](https://github.com/kitodo/kitodo-contentserver), [Kitodo.Production](https://github.com/kitodo/kitodo-production) und [Kitodo.UGH](https://github.com/kitodo/kitodo-ugh) * **Branch 2.x**: ist die Weiterentwicklung der alten Goobi.Production Community Edition (Version 1.11.x) unter dem neuen Namen Kitodo.Production und wird als Version 2.x weiter geführt -* **Branch master**: die unter dem DFG Projekt geförderten Weiterentwicklung von Kitodo.Production findet hier statt und enthält auch die darauf basierenden betriebenen Entwicklungen +* **Branch main (ehemals master)**: die unter dem DFG Projekt geförderten Weiterentwicklung von Kitodo.Production findet hier statt und enthält auch die darauf basierenden betriebenen Entwicklungen diff --git a/docs/index.md b/docs/index.md index bbedebe6de1..a3dad0ba7fd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ # Kitodo.Production Developer Documentation * Read the docs: -* GitHub: +* GitHub: This documentation is work in progress. Please consult the [javadoc](developer/javadoc/README.md) or [contact the developer team](https://maillist.slub-dresden.de/cgi-bin/mailman/listinfo/kitodo-developer) if you have specific questions that are not covered here yet.