docs/en/deployment/quick-start.md
To help you quickly get started with the Apollo Configuration Center, we have prepared a Quick Start here, which can deploy and start Apollo Configuration Center in your local environment in a few minutes.
If you are familiar with Docker, you can refer to Apollo Quick Start Docker Deployment to deploy Apollo via Docker. Apollo Quick Start Docker.
However, it should be noted that Quick Start is only for local testing, if you want to deploy to production environment, please refer to distributed-deployment-guide separately.
Note: Quick Start requires a bash environment, Windows users please install Git Bash, we recommend using the latest version, older versions may encounter unknown problems. You can also start directly through the IDE environment, see Apollo Development Guide for details.
Once configured, this can be checked with the following command.
java -version
Sample output.
java version "17.0.14"
Java(TM) SE Runtime Environment (build 17.0.14+7)
Java HotSpot(TM) 64-Bit Server VM (build 17.0.14+7, mixed mode)
Windows users please make sure that JAVA_HOME environment variable is set.
Apollo's table structure uses multiple default declarations for timestamp, so version 5.6.5+ is required.
After connecting to MySQL, you can check with the following command.
SHOW VARIABLES WHERE Variable_name = 'version';
| Variable_name | Value |
|---|---|
| version | 5.7.11 |
We have prepared a Quick Start installation package, you just need to download it locally and you can use it directly, eliminating the need to compile and package the process.
The installation package is 50M, if you can't access github, you can download it from Baidu.com.
Quick Start is only for local testing, so generally users do not need to download the source code to package it themselves, but just download the already typed package. However, there are some users who want to repackage the package after modifying the code, then you can refer to the following steps.
mvn clean package -pl apollo-assembly -am -DskipTests=true in the root directory.github in the SPRING_PROFILES_ACTIVE environment variable in the script is a required profile, database-discovery specifies the use of database service discovery, auth is a profile that provides simple authentication for the portal, it can be removed if authentication is not required or other authentication methods are used.No configuration is required, just use the following command to start
Note: When using the in-memory database, any operation will be lost after the Apollo process restarts
export SPRING_PROFILES_ACTIVE="github,database-discovery,auth"
unset SPRING_SQL_CONFIG_INIT_MODE
unset SPRING_SQL_PORTAL_INIT_MODE
java -jar apollo-all-in-one.jar
~/apollo/apollo-config-db and ~/apollo/apollo-portal-db in the environment variable in the script can be replaced with other custom paths, you need to ensure that this path has read and write permissionsUse the SPRING_SQL_CONFIG_INIT_MODE="always" and SPRING_SQL_PORTAL_INIT_MODE="always" environment variable for initialization at the first startup
export SPRING_PROFILES_ACTIVE="github,database-discovery,auth"
# config db
export SPRING_SQL_CONFIG_INIT_MODE="always"
export SPRING_CONFIG_DATASOURCE_URL="jdbc:h2:file:~/apollo/apollo-config-db;mode=mysql;DB_CLOSE_ON_EXIT=FALSE;DB_CLOSE_DELAY=-1;BUILTIN_ALIAS_OVERRIDE=TRUE;DATABASE_TO_UPPER=FALSE"
# portal db
export SPRING_SQL_PORTAL_INIT_MODE="always"
export SPRING_PORTAL_DATASOURCE_URL="jdbc:h2:file:~/apollo/apollo-portal-db;mode=mysql;DB_CLOSE_ON_EXIT=FALSE;DB_CLOSE_DELAY=-1;BUILTIN_ALIAS_OVERRIDE=TRUE;DATABASE_TO_UPPER=FALSE"
java -jar apollo-all-in-one.jar
Remove the SPRING_SQL_CONFIG_INIT_MODE and SPRING_SQL_PORTAL_INIT_MODE environment variable to avoid repeated initialization at subsequent startup
export SPRING_PROFILES_ACTIVE="github,database-discovery,auth"
# config db
unset SPRING_SQL_CONFIG_INIT_MODE
export SPRING_CONFIG_DATASOURCE_URL="jdbc:h2:file:~/apollo/apollo-config-db;mode=mysql;DB_CLOSE_ON_EXIT=FALSE;DB_CLOSE_DELAY=-1;BUILTIN_ALIAS_OVERRIDE=TRUE;DATABASE_TO_UPPER=FALSE"
# portal db
unset SPRING_SQL_PORTAL_INIT_MODE
export SPRING_PORTAL_DATASOURCE_URL="jdbc:h2:file:~/apollo/apollo-portal-db;mode=mysql;DB_CLOSE_ON_EXIT=FALSE;DB_CLOSE_DELAY=-1;BUILTIN_ALIAS_OVERRIDE=TRUE;DATABASE_TO_UPPER=FALSE"
java -jar apollo-all-in-one.jar
Use the SPRING_SQL_INIT_MODE="always" environment variable for initialization at the first startup
export SPRING_PROFILES_ACTIVE="github,database-discovery,auth"
# config db
export SPRING_SQL_CONFIG_INIT_MODE="always"
export SPRING_CONFIG_DATASOURCE_URL="jdbc:mysql://your-mysql-server:3306/ApolloConfigDB?useUnicode=true&characterEncoding=UTF8"
export SPRING_CONFIG_DATASOURCE_USERNAME="apollo-username"
export SPRING_CONFIG_DATASOURCE_PASSWORD="apollo-password"
# portal db
export SPRING_SQL_PORTAL_INIT_MODE="always"
export SPRING_PORTAL_DATASOURCE_URL="jdbc:mysql://your-mysql-server:3306/ApolloPortalDB?useUnicode=true&characterEncoding=UTF8"
export SPRING_PORTAL_DATASOURCE_USERNAME="apollo-username"
export SPRING_PORTAL_DATASOURCE_PASSWORD="apollo-password"
java -jar apollo-all-in-one.jar
Remove the SPRING_SQL_CONFIG_INIT_MODE and SPRING_SQL_PORTAL_INIT_MODE environment variable to avoid repeated initialization at subsequent startup
export SPRING_PROFILES_ACTIVE="github,database-discovery,auth"
# config db
unset SPRING_SQL_CONFIG_INIT_MODE
export SPRING_CONFIG_DATASOURCE_URL="jdbc:mysql://your-mysql-server:3306/ApolloConfigDB?useUnicode=true&characterEncoding=UTF8"
export SPRING_CONFIG_DATASOURCE_USERNAME="apollo-username"
export SPRING_CONFIG_DATASOURCE_PASSWORD="apollo-password"
# portal db
unset SPRING_SQL_PORTAL_INIT_MODE
export SPRING_PORTAL_DATASOURCE_URL="jdbc:mysql://your-mysql-server:3306/ApolloPortalDB?useUnicode=true&characterEncoding=UTF8"
export SPRING_PORTAL_DATASOURCE_USERNAME="apollo-username"
export SPRING_PORTAL_DATASOURCE_PASSWORD="apollo-password"
java -jar apollo-all-in-one.jar
You can import apolloconfigdb.sql to ApolloConfigDB through various MySQL clients. You can import apolloportaldb.sql to ApolloPortalDB through various MySQL clients.
export SPRING_PROFILES_ACTIVE="github,database-discovery,auth"
# config db
unset SPRING_SQL_CONFIG_INIT_MODE
export SPRING_CONFIG_DATASOURCE_URL="jdbc:mysql://your-mysql-server:3306/ApolloConfigDB?useUnicode=true&characterEncoding=UTF8"
export SPRING_CONFIG_DATASOURCE_USERNAME="apollo-username"
export SPRING_CONFIG_DATASOURCE_PASSWORD="apollo-password"
# portal db
unset SPRING_SQL_PORTAL_INIT_MODE
export SPRING_PORTAL_DATASOURCE_URL="jdbc:mysql://your-mysql-server:3306/ApolloPortalDB?useUnicode=true&characterEncoding=UTF8"
export SPRING_PORTAL_DATASOURCE_USERNAME="apollo-username"
export SPRING_PORTAL_DATASOURCE_PASSWORD="apollo-password"
java -jar apollo-all-in-one.jar
Quick Start is only used to help you quickly experience Apollo project, please refer to: distributed-deployment-guide for details.
It should be noted that Quick Start does not support adding environments, but only through distributed deployment, please refer to: distributed-deployment-guide
Quick Start integrates with Spring Security simple authentication, for more information you can refer to Portal implementing user login function
SampleApp information, and submit.timeout information, and submit.We have prepared a simple Demo client to demonstrate getting configuration from Apollo Configuration Center.
The program is simple: the user enters the name of a key, and the program outputs the value corresponding to that key.
If the key is not found, undefined is output.
Also, the client listens for configuration change events and outputs the changed configuration information once there is a change.
Run ./demo.sh client to start the demo client and ignore the previous debugging information, you can see the following prompt.
Apollo Config Demo. Please input key to get the value. Input quit to exit.
>
Enter timeout and you will see the following message.
> timeout
Loading key : timeout with value: 1000
If you encounter problems running the client, you can view more detailed logging information by changing the level in
client/log4j2.xmlto DEBUGxml<logger name="com.ctrip.framework.apollo" additivity="false" level="trace"> <AppenderRef ref="Async" level="DEBUG"/> </logger>
Return to the configuration interface, change the value of timeout to 2000, and release the configuration.
If the client has been running, it will listen for configuration changes after the configuration is published and output the modified configuration information as follows.
Changes for namespace application
Change - key: timeout, oldValue: 1000, newValue: 2000, changeType: MODIFIED
Type timeout again to see the corresponding value and you will see the following message.
> timeout
Loading key : timeout with value: 2000
This part can be found in Java Application Access Guide
Since a new project is used, the client needs to modify the appId information.
Edit client/META-INF/app.properties and change app.id to your newly created app id.
app.id=your appId
Run `./demo.sh client` to start the demo client.