README
¶
xconfadmin
This project is to implement a configuration management server. RDK devices download configurations from this server during bootup or notified when updates are available.
Install go
This project is written and tested with Go 1.23*
Build the binary
cd $HOME/go/src/github.com/comcast-cl/xconfadmin
make
bin/xconfadmin-linux-amd64 will be created.
Run the application
The application includes an API to notify RDK devices to download updated configurations from this server. A JWT token is required to communicate with service. The credentials are passed to the application through environment variables. A configuration file can be passed as an argument when the application starts. config/sample_xconfadmin.conf is an example.
export SAT_CLIENT_ID='xxxxxx'
export SAT_CLIENT_SECRET='yyyyyy'
export SECURITY_TOKEN_KEY='zzzzzz'
mkdir -p /app/logs/xconfadmin
cd $HOME/go/src/github.com/comcast-cl/xconfadmin
bin/xconfadmin-linux-amd64 -f config/sample_xconfadmin.conf
curl http://localhost:9000/api/v1/version
{"status":200,"message":"OK","data":{"code_git_commit":"2ac7ff4","build_time":"Thu Feb 14 01:57:26 2019 UTC","binary_version":"317f2d4","binary_branch":"develop","binary_build_time":"2021-02-10_18:26:49_UTC"}}
Documentation
¶
Overview ¶
Copyright 2025 Comcast Cable Communications Management, LLC
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
SPDX-License-Identifier: Apache-2.0
Source Files
Directories