유비온 서버 설치 문서 v1

1.몽고디비는 생성해서 사용하세요 (uss-dev, logdb)

→ 기본 컬렉션 기본값은 설정방식은 별도로 전달

2.인스턴스서버 3가지 설치 (frontend, backend (API), aibackend (AI))

→ 각각의 env 파일은 별도로 전달

[Setup Veluga Backend 컨테이너 설치 가이드]

1. 사전 준비 사항

Docker 설치: Docker가 설치되어 있어야 합니다. Docker 설치 방법은 Docker 공식 문서를 참고하세요.

2. Docker 이미지 Pull

Azure Container Registry(ACR)에 저장된 Docker 이미지를 Pull하려면 다음 단계를 따르세요.

2.1. ACR 로그인

외부업체는 ACR에 접근할 수 있는 인증 정보(사용자 이름 및 비밀번호)를 제공받아야 합니다. 다음 명령어를 사용하여 ACR에 로그인합니다.


docker login ubioncontainerregistry.azurecr.io -u <ACR_USERNAME> -p <ACR_PASSWORD>

<ACR_USERNAME>: 제공받은 ACR 사용자 이름

<ACR_PASSWORD>: 제공받은 ACR 비밀번호

2.2. Docker 이미지 Pull

로그인 후, 다음 명령어를 사용하여 Docker 이미지를 Pull합니다.

docker pull ubioncontainerregistry.azurecr.io/setup-veluga-backend:latest

latest: 최신 버전의 이미지를 Pull합니다. 특정 태그가 필요한 경우, 해당 태그로 변경하세요.

3. 환경 변수 파일 준비

아래는 .env.setup 파일의 예시 템플릿입니다.

API 서버는 는 .env 로 파일 이름 변경 하여 사용!!!

3.1. .env.setup 파일 예시


PORT=8080
NODE_ENV=uss-dev
ENVIROMENT=dev

# JWT 및 암호화 비밀키
JWT_SECRET=your_jwt_secret_here
ENCRYPTION_SECRET=your_encryption_secret_here

# AWS SQS 설정
AWS_ACCESS_KEY_ID=your_aws_access_key
AWS_SECRET_ACCESS_KEY=your_aws_secret_key
AWS_SQS_QUEUE_URL=your_sqs_queue_url

# MongoDB 설정
MONGO_CLUSTER=your_mongo_cluster_url
MONGO_LOGDB=your_mongo_logdb_url
MONGO_DBNAME=your_db_name
MONGO_USER=your_mongo_user
MONGO_PASSWORD=your_mongo_password

# API URL 설정
SERVER_URL=http://localhost:8080
PAYMENT_SERVER_URL=your_payment_server_url

# AI 서버 URL 설정
AI_SERVER_URL=http://localhost:8000
AI_BIZ_SERVER_URL=your_ai_biz_server_url

# Mailgun 및 Payment API 키
MAILGUN_API_KEY=your_mailgun_api_key
PAYMENT_API_KEY=your_payment_api_key

# GCP 자격 증명
VELUGA_BACKEND_GOOGLE_CREDENTIAL='your_google_credentials_json'
VELUGA_BACKEND_GOOGLE_SA='your_google_service_account_json'

# 인증 콜백 URL
SOCIAL_LOGIN_CALLBACK_URL=https://your-api-url/social/callback
NOTION_CALLBACK_URL=https://your-api-url/external-app/notion/callback

# 소셜 인증 설정
SOCIAL_KAKAO_CLIENT_ID=your_kakao_client_id
SOCIAL_KAKAO_CLIENT_SECRET_ID=your_kakao_client_secret
SOCIAL_GOOGLE_CLIENT_ID=your_google_client_id
SOCIAL_GOOGLE_CLIENT_SECRET_ID=your_google_client_secret
SOCIAL_NAVER_CLIENT_ID=your_naver_client_id
SOCIAL_NAVER_CLIENT_SECRET_ID=your_naver_client_secret
SOCIAL_NOTION_CLIENT_ID=your_notion_client_id
SOCIAL_NOTION_CLIENT_SECRET_ID=your_notion_client_secret

# 법령 API 정보
LAW_API_OC_NAME=your_law_api_name
LAW_API_DOMAIN=your_law_api_domain
LAW_API_SEARCH_DOMAIN=your_law_api_search_domain
LAW_DOMAIN=your_law_domain
PREC_DOMAIN=your_prec_domain

# 암호화 API 키
ENCRYPTION_API_KEY_SECRET=your_encryption_api_key_secret

주의사항:

모든 your_* 항목을 실제 값으로 대체하세요.

env.setup → .env 이름 변경

.env파일은 보안상 안전한 위치에 보관하고, 접근 권한을 제한하세요.

4. Docker 컨테이너 실행

환경 변수 파일을 준비한 후, 다음 명령어를 사용하여 Docker 컨테이너를 실행합니다.


docker run -d -p 8080:8080 --env-file ./path/to/.env ubioncontainerregistry.azurecr.io/setup-veluga-backend:latest

명령어 설명

d: 컨테이너를 백그라운드에서 실행합니다.

p 8080:8080: 호스트의 포트 8080을 컨테이너의 포트 8080에 매핑합니다. 필요에 따라 포트를 변경할 수 있습니다.

-env-file ./path/to/.env: 외부업체가 생성한 .env파일의 경로를 지정합니다.

ubioncontainerregistry.azurecr.io/setup-veluga-backend:latest: 사용하려는 Docker 이미지와 태그입니다.

예시:

docker run -d -p 8080:8080 --env-file ./env.setup ubioncontainerregistry.azurecr.io/setup-veluga-backend:latest

5. 컨테이너 상태 확인 및 관리

5.1. 실행 중인 컨테이너 확인

docker ps

5.2. 컨테이너 로그 확인

실행 중인 컨테이너의 로그를 확인하려면 다음 명령어를 사용하세요.

docker logs <컨테이너_ID>

5.3. 컨테이너 중지

컨테이너를 중지하려면 다음 명령어를 사용하세요.

docker stop <컨테이너_ID>

5.4. 컨테이너 제거

컨테이너를 제거하려면 다음 명령어를 사용하세요.

docker rm <컨테이너_ID>

[Setup Veluga AI Backend 컨테이너 설치 가이드]

1. 사전 준비 사항

Docker 설치: Docker가 설치되어 있어야 합니다. Docker 설치 방법은 Docker 공식 문서를 참고하세요.

2. Docker 이미지 Pull

Azure Container Registry(ACR)에 저장된 Docker 이미지를 Pull하려면 다음 단계를 따르세요.

2.1. ACR 로그인

외부업체는 ACR에 접근할 수 있는 인증 정보(사용자 이름 및 비밀번호)를 제공받아야 합니다. 다음 명령어를 사용하여 ACR에 로그인합니다.

docker login ubioncontainerregistry.azurecr.io -u <ACR_USERNAME> -p <ACR_PASSWORD>

<ACR_USERNAME>: 제공받은 ACR 사용자 이름

<ACR_PASSWORD>: 제공받은 ACR 비밀번호

2.2. Docker 이미지 Pull

로그인 후, 다음 명령어를 사용하여 Docker 이미지를 Pull합니다.

docker pull ubioncontainerregistry.azurecr.io/setup-veluga-ai-backend:latest

latest: 최신 버전의 이미지를 Pull합니다. 특정 태그가 필요한 경우, 해당 태그로 변경하세요. 예를 들어, 특정 커밋 해시를 사용할 수 있습니다.

3. 환경 변수 파일 준비

아래는 .env.setup 파일의 예시 템플릿입니다.

AI서버는 는 .env 로 파일 이름 변경 하지 않습니다. .env.setup 그대로 사용

3.1. .env.setup 파일 예시

ENV=uss-dev
PORT=8000

# AWS SQS 실제 큐를 생성하여야 합니다. 이큐는 사용 예시입니다. (밑에 형식을 유지 해주세요)
AWS_ACCESS_KEY_ID=your_aws_access_key
AWS_SECRET_ACCESS_KEY=your_aws_secret_key
AWS_QUEUE_NAME=your_sqs_queue_name

# 임시 ubion/samsung 용 생성키를 생성했습니다.
OPENAI_API_KEY=your_openai_api_key
ANTHROPIC_API_KEY=your_anthropic_api_key

VOYAGE_API_KEY=your_voyage_api_key

# Azure OpenAI API 사용안함
OPENAI_AZURE_API_BASE=https://your-openai-azure-endpoint/
OPENAI_AZURE_API_KEY=your_openai_azure_api_key
OPENAI_AZURE_API_TYPE=azure
OPENAI_AZURE_API_VERSION=2023-05-15

# Pinecone 파인콘에 생성된 테스트 인덱스
PINECONE_API_KEY=your_pinecone_api_key
PINECONE_ENVIRONMENT=your_pinecone_environment
PINECONE_INDEX_NAME=your_pinecone_index_name
PINECONE_HYBRID_INDEX_NAME=your_pinecone_hybrid_index_name
PINECONE_QUESTION_INDEX_NAME=your_pinecone_question_index_name

# 직접 만들어 설정 바랍니다. dev / logdb
MONGO_URL=your_mongo_cluster_url
MONGO_LOGDB=your_mongo_logdb_url
MONGO_DBNAME=your_db_name

# Veluga-backend 서버 주소
VELUGA_API_SERVER_URL=https://your-api-url

COHERE_API_KEY=your_cohere_api_key

NCP_CLOVASTUDIO_HOST=https://clovastudio.stream.ntruss.com
NCP_CLOVASTUDIO_API_KEY=your_ncp_clovastudio_api_key
NCP_APIGW_API_KEY=your_ncp_apigw_api_key

GOOGLE_API_KEY=your_google_api_key
GOOGLE_CLOUD_PROJECT_ID=your_google_cloud_project_id

SOLAR_API_BASE_URL=your_solar_api_base_url
SOLAR_API_KEY=your_solar_api_key

NEO4J_URL=your_neo4j_url
NEO4J_USER=your_neo4j_user
NEO4J_PASSWORD=your_neo4j_password

CHROME_DRIVER_PATH=modules/static/chromedriver/linux/chromedriver127
CHROME_EXE_PATH=/opt/google/chrome/chrome-linux64/chrome

주의사항:

모든 your_* 항목을 실제 값으로 대체하세요.

.env.setup 파일은 보안상 안전한 위치에 보관하고, 접근 권한을 제한하세요.

4. Docker 컨테이너 실행

환경 변수 파일을 준비한 후, 다음 명령어를 사용하여 Docker 컨테이너를 실행합니다.

docker run -d -p 8000:8000 --env-file ./path/to/.env.setup ubioncontainerregistry.azurecr.io/setup-veluga-ai-backend:latest

명령어 설명

d: 컨테이너를 백그라운드에서 실행합니다.

p 8000:8000: 호스트의 포트 8000을 컨테이너의 포트 8000에 매핑합니다. 필요에 따라 포트를 변경할 수 있습니다.

-env-file ./path/to/.env.setup: 외부업체가 생성한 .env.setup 파일의 경로를 지정합니다.

ubioncontainerregistry.azurecr.io/setup-veluga-ai-backend:latest : 사용하려는 Docker 이미지와 태그입니다.:latest: 사용하려는 Docker 이미지와 태그입니다.

예시:

docker run -d -p 8000:8000 --env-file ./env.setup ubioncontainerregistry.azurecr.io/setup-veluga-ai-backend:latest

5. 컨테이너 상태 확인 및 관리

5.1. 실행 중인 컨테이너 확인

docker ps

5.2. 컨테이너 로그 확인

실행 중인 컨테이너의 로그를 확인하려면 다음 명령어를 사용하세요.

docker logs <컨테이너_ID>

5.3. 컨테이너 중지

컨테이너를 중지하려면 다음 명령어를 사용하세요.

docker stop <컨테이너_ID>

5.4. 컨테이너 제거

컨테이너를 제거하려면 다음 명령어를 사용하세요.

setup-veluga-backend

[Setup Veluga Frontend 컨테이너 설치 가이드]

1. Docker 이미지 Pull 및 실행

1.1. ACR 로그인

Azure Container Registry(ACR)에서 이미지를 Pull하기 위해 인증이 필요합니다. 다음 명령어를 사용하여 ACR에 로그인합니다.

docker login ubioncontainerregistry.azurecr.io -u <ACR_USERNAME> -p <ACR_PASSWORD>

<ACR_USERNAME>: 제공받은 ACR 사용자 이름

<ACR_PASSWORD>: 제공받은 ACR 비밀번호

1.2. Docker 이미지 Pull

아래 명령어를 사용하여 ACR에서 Docker 이미지를 Pull합니다.

docker pull ubioncontainerregistry.azurecr.io/setup-veluga-frontend:latest

2. 환경 변수 파일 생성

외부업체는 필요한 환경 변수를 포함한 .env.local 파일을 작성해야 합니다. 이 파일은 Docker 실행 시 컨테이너에 환경 변수를 전달합니다.

2.1. .env.local 파일 예시

NEXT_PUBLIC_ENV_MODE=production
NEXT_PUBLIC_ENV_B2B=false
NEXT_PUBLIC_APP_MODE=veluga
NEXT_PUBLIC_B2B_MODE=false
NEXT_PUBLIC_VELUGA_URL=https://veluga.app
NEXT_PUBLIC_VELUGA_SERVER_URL=https://api.veluga.app
NEXT_PUBLIC_CONNECT_VELUGA_GMAIL=https://mail.google.com/mail/?view=cm&fs=1&tf=1&to=contact@veluga.io
NEXT_PUBLIC_COXWAVE_SERVER_URL=https://ozuxm2owyem3yxksb3ddu7g7ae0fxavq.lambda-url.us-east-1.on.aws/api
NEXT_PUBLIC_VELUGA_PRIVACY_POLICY=https://slashpage.com/veluga-policy/qrx6zk25jjvvxmv314y5
NEXT_PUBLIC_VELUGA_PRIVACY_POLICY_EN=https://slashpage.com/veluga-policy/d367nxm344r892j98pv1
NEXT_PUBLIC_VELUGA_TERMS_OF_SERVICE=https://slashpage.com/veluga-policy/ywk9j72955w7x2gpqvnd
NEXT_PUBLIC_VELUGA_TERMS_OF_SERVICE_EN=https://slashpage.com/veluga-policy/qpv5x42788q75mkyn3dw
NEXT_PUBLIC_KO_LANDING_CHATBOT=/channel/65d990d56e47ccd7a1d72177?embed=true
NEXT_PUBLIC_EN_LANDING_CHATBOT=/channel/65e1fd0b6e47ccd7a1f4bf18?embed=true
NEXT_PUBLIC_KO_DASHBOARD_CHATBOT=/channel/65e1f8d66e47ccd7a1f46a14?embed=true
NEXT_PUBLIC_EN_DASHBOARD_CHATBOT=/channel/65e1faef6e47ccd7a1f49996?embed=true

변경
NEXT_PUBLIC_API_URL=내 도메인 (http://localhost:3000)
NEXT_PUBLIC_OTHER_VAR= API backend Server (http://localhost:8080)

주의사항:

.env.local 파일은 민감한 정보가 포함될 수 있으므로 안전한 위치에 보관하고 접근 권한을 제한하세요.

이 파일의 이름은 **.env.local*로 지정되어야 하며, 컨테이너 실행 시 해당 파일을 경로와 함께 전달합니다.

3. Docker 컨테이너 실행

아래 명령어를 사용하여 Docker 컨테이너를 실행합니다. .env.local 파일을 전달하여 환경 변수를 적용합니다.

docker run -d -p 3000:3000 --env-file ./env.local ubioncontainerregistry.azurecr.io/setup-veluga-frontend:latest

명령어 설명

d: 컨테이너를 백그라운드에서 실행합니다.

p 3000:3000: 호스트의 포트 3000을 컨테이너의 포트 3000에 매핑합니다.

-env-file ./env.local: 외부의 .env.local 파일을 사용하여 환경 변수를 전달합니다.

ubioncontainerregistry.azurecr.io/setup-veluga-frontend:latest: 사용할 Docker 이미지와 태그입니다.

서비스 접근 확인

VelugaFrontend: http://localhost:3000

VelugaBackend (API): http://localhost:8080

VelugaAIBackend (AI): http://localhost:8000

Made with SlashPage