kodehat/portkey

어떤 프로젝트인가요?

핵심 기능

• 01링크를 이름이 있는 그룹으로 정리해 시작 페이지에 표시합니다.
• 02키워드를 설정할 수 있으며 퍼지 검색도 선택적으로 지원합니다.
• 03외부 링크의 파비콘을 자동으로 가져와 캐시합니다.
• 04이모지, 이미지 파일, URL을 포털 아이콘으로 사용할 수 있습니다.
• 05지정한 경로에 사용자 지정 HTML 페이지를 추가할 수 있습니다.
• 06전체 설정을 YAML 파일 하나로 관리하며, 환경 변수로 값을 재정의할 수 있습니다.

활용 사례

• 자주 방문하는 내부 도구와 사이트를 위한 브라우저 시작 페이지로 사용합니다.
• 홈 서버나 인트라넷에서 팀이 함께 쓰는 링크 대시보드를 운영합니다.
• 리소스 목록과 함께 간단한 사용자 지정 정보 페이지를 게시합니다.

빠른 시작

1. 1

   사용 중인 OS용 portkey 파일을 다운로드해 PATH에 배치합니다

2. 2

   config.yml을 만들거나 저장소의 예제 구성을 사용합니다

3. 3

   설정 파일 경로를 지정해 애플리케이션을 시작합니다(config.yml이 작업 디렉터리에 있으면 생략 가능)

   portkey --config-path=<dir_to_config_yml>
4. 4

   지정된 호스트와 포트에서 브라우저를 엽니다. 기본값은 http://localhost:3000입니다

사용 전 알아둘 점

• !AGPL-3.0 라이선스로 제공됩니다. 강한 카피레프트 라이선스로, 수정된 버전을 네트워크를 통해 제공하는 경우에도 적용됩니다.
• !아이콘이 없는 외부 포털에서는 파비콘을 가져오기 위해 외부로 HTTP 요청을 보냅니다.

포함된 컬렉션

토픽

자주 묻는 질문

portkey은(는) 무엇인가요?

설정 파일 하나로 구성하는 가벼운 셀프 호스팅 시작 페이지로, 검색과 간단한 사용자 지정 페이지를 지원합니다. portkey는 브라우저 시작 페이지나 개인 링크 대시보드로 사용할 수 있는 웹 포털입니다. 링크를 config.yml 파일 하나에 입력하고 원하는 경우 이름이 있는 섹션으로 묶으면, 앱이 검색 가능한 홈 페이지로 제공하며 다크 모드와 라이트 모드를 지원합니다.

portkey은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?

portkey은(는) AGPL-3.0 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.

portkey은(는) 아직 유지보수되고 있나요?

활발히 유지보수 중. portkey의 마지막 커밋은 2026년 11월 6일입니다.

portkey은(는) 어디에 사용할 수 있나요?

자주 방문하는 내부 도구와 사이트를 위한 브라우저 시작 페이지로 사용합니다. 홈 서버나 인트라넷에서 팀이 함께 쓰는 링크 대시보드를 운영합니다. 리소스 목록과 함께 간단한 사용자 지정 정보 페이지를 게시합니다.

portkey는 어떻게 설치하나요?

사용 중인 OS용 portkey 파일을 다운로드해 PATH에 배치합니다 config.yml을 만들거나 저장소의 예제 구성을 사용합니다 설정 파일 경로를 지정해 애플리케이션을 시작합니다(config.yml이 작업 디렉터리에 있으면 생략 가능): portkey --config-path=<dir_to_config_yml> 지정된 호스트와 포트에서 브라우저를 엽니다. 기본값은 http://localhost:3000입니다

portkey은(는) 어디서 받을 수 있나요?

소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/kodehat/portkey