mirror of
				https://github.com/gethomepage/homepage.git
				synced 2025-11-03 19:17:03 -05:00 
			
		
		
		
	merge with main
This commit is contained in:
		
						commit
						a1841f26bb
					
				
							
								
								
									
										2
									
								
								.github/workflows/docker-publish.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								.github/workflows/docker-publish.yml
									
									
									
									
										vendored
									
									
								
							@ -79,6 +79,8 @@ jobs:
 | 
			
		||||
        uses: docker/metadata-action@v4
 | 
			
		||||
        with:
 | 
			
		||||
          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
 | 
			
		||||
          flavor: |
 | 
			
		||||
            latest=auto
 | 
			
		||||
 | 
			
		||||
      # Build and push Docker image with Buildx (don't push on PR)
 | 
			
		||||
      # https://github.com/docker/build-push-action
 | 
			
		||||
 | 
			
		||||
@ -25,7 +25,7 @@ If you have a more specific issue, please open an issue on the [Issues](https://
 | 
			
		||||
 | 
			
		||||
## Getting Started
 | 
			
		||||
 | 
			
		||||
You can run the homepage from a docker container or locally using node.
 | 
			
		||||
For configuration options, examples and more, [please check out the Wiki](https://github.com/benphelps/homepage/wiki).
 | 
			
		||||
 | 
			
		||||
### With Docker
 | 
			
		||||
 | 
			
		||||
@ -35,7 +35,7 @@ Using docker compose:
 | 
			
		||||
version: '3.3'
 | 
			
		||||
services:
 | 
			
		||||
    homepage:
 | 
			
		||||
        image: ghcr.io/benphelps/homepage:main
 | 
			
		||||
        image: ghcr.io/benphelps/homepage:latest
 | 
			
		||||
        container_name: homepage
 | 
			
		||||
        ports:
 | 
			
		||||
            - 3000:3000
 | 
			
		||||
@ -47,7 +47,7 @@ services:
 | 
			
		||||
or docker run:
 | 
			
		||||
 | 
			
		||||
```bash
 | 
			
		||||
docker run -p 3000:3000 -v /path/to/config:/app/config -v /var/run/docker.sock:/var/run/docker.sock ghcr.io/benphelps/homepage:main
 | 
			
		||||
docker run -p 3000:3000 -v /path/to/config:/app/config -v /var/run/docker.sock:/var/run/docker.sock ghcr.io/benphelps/homepage:latest
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### With Node
 | 
			
		||||
 | 
			
		||||
@ -49,8 +49,12 @@ export default function Docker({ service }) {
 | 
			
		||||
    <Widget>
 | 
			
		||||
      <Block label="CPU" value={`${calculateCPUPercent(statsData.stats)}%`} />
 | 
			
		||||
      <Block label="MEM" value={formatBytes(statsData.stats.memory_stats.usage, 0)} />
 | 
			
		||||
      {statsData.stats.networks && (
 | 
			
		||||
        <>
 | 
			
		||||
          <Block label="RX" value={formatBytes(statsData.stats.networks.eth0.rx_bytes, 0)} />
 | 
			
		||||
          <Block label="TX" value={formatBytes(statsData.stats.networks.eth0.tx_bytes, 0)} />
 | 
			
		||||
        </>
 | 
			
		||||
      )}
 | 
			
		||||
    </Widget>
 | 
			
		||||
  );
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
@ -1,34 +1,17 @@
 | 
			
		||||
- Developer: # Bookmark group title
 | 
			
		||||
    - Github: # Bookmark title
 | 
			
		||||
        - abbr: GH # Two letter abbrivation for the bookmark
 | 
			
		||||
          href: https://github.com/ # URL to link out to
 | 
			
		||||
# For configuration options and examples, please see:
 | 
			
		||||
# https://github.com/benphelps/homepage/wiki/Bookmarks
 | 
			
		||||
 | 
			
		||||
    - StackOverflow:
 | 
			
		||||
        - abbr: SO
 | 
			
		||||
          href: https://stackoverflow.com/
 | 
			
		||||
 | 
			
		||||
    - DEV:
 | 
			
		||||
        - abbr: DT
 | 
			
		||||
          href: https://dev.to/
 | 
			
		||||
- Developer:
 | 
			
		||||
    - Github:
 | 
			
		||||
        - abbr: GH
 | 
			
		||||
          href: https://github.com/
 | 
			
		||||
 | 
			
		||||
- Social:
 | 
			
		||||
    - LinkedIn:
 | 
			
		||||
        - abbr: LI
 | 
			
		||||
          href: https://linkedin.com/
 | 
			
		||||
 | 
			
		||||
    - Twitter:
 | 
			
		||||
        - abbr: TW
 | 
			
		||||
          href: https://twitter.com/
 | 
			
		||||
    - Reddit:
 | 
			
		||||
        - abbr: RE
 | 
			
		||||
          href: https://reddit.com/
 | 
			
		||||
 | 
			
		||||
- Entertainment:
 | 
			
		||||
    - YouTube:
 | 
			
		||||
        - abbr: YT
 | 
			
		||||
          href: https://youtube.com/
 | 
			
		||||
 | 
			
		||||
    - Netflix:
 | 
			
		||||
        - abbr: NF
 | 
			
		||||
          href: https://netflix.com/
 | 
			
		||||
 | 
			
		||||
    - Reddit:
 | 
			
		||||
        - abbr: RE
 | 
			
		||||
          href: https://reddit.com/
 | 
			
		||||
 | 
			
		||||
@ -1,6 +1,5 @@
 | 
			
		||||
# Docker host configuration, used for docker integrations
 | 
			
		||||
# Can be either a host and port (e.g. 127.0.0.1:2375),
 | 
			
		||||
# or a unix socket path (e.g. /var/run/docker.sock)
 | 
			
		||||
# For configuration options and examples, please see:
 | 
			
		||||
# https://github.com/benphelps/homepage/wiki/Docker-Integration
 | 
			
		||||
 | 
			
		||||
my-docker:
 | 
			
		||||
  host: 127.0.0.1
 | 
			
		||||
 | 
			
		||||
@ -1,53 +1,17 @@
 | 
			
		||||
- Media: # Services Group Title
 | 
			
		||||
    - Emby: # Service Title
 | 
			
		||||
        icon: emby.png # Icon, see: https://github.com/walkxcode/dashboard-icons or public/icons
 | 
			
		||||
        href: http://emby.home/ # Link to the service
 | 
			
		||||
        description: Media server # Description of the service
 | 
			
		||||
        server: my-docker # Docker server the service is running on
 | 
			
		||||
        container: emby # Docker container the service is running on
 | 
			
		||||
# For configuration options and examples, please see:
 | 
			
		||||
# https://github.com/benphelps/homepage/wiki/Services
 | 
			
		||||
 | 
			
		||||
    - Radarr:
 | 
			
		||||
        icon: radarr.png
 | 
			
		||||
        href: http://radarr.home/
 | 
			
		||||
        description: Movie management
 | 
			
		||||
        server: my-docker
 | 
			
		||||
        container: radarr
 | 
			
		||||
        widget: # Service widget configuration
 | 
			
		||||
          type: radarr # Widget type, currently supports types radarr, sonarr, ombi or portainer
 | 
			
		||||
          url: http://radarr.home # Base URL of the service, where the API is located
 | 
			
		||||
          key: apikeyapikeyapikeyapikey # API key of the service
 | 
			
		||||
- My First Group:
 | 
			
		||||
    - My First Service:
 | 
			
		||||
        href: http://localhosdt/
 | 
			
		||||
        description: Homepage is awesome
 | 
			
		||||
 | 
			
		||||
- Documents & Files:
 | 
			
		||||
    - ruTorrent:
 | 
			
		||||
        icon: rutorrent.png
 | 
			
		||||
        href: http://rutorrent.home/
 | 
			
		||||
        description: Torrent downloader
 | 
			
		||||
        server: my-docker
 | 
			
		||||
        container: rutorrent
 | 
			
		||||
- My Second Group:
 | 
			
		||||
    - My Second Service:
 | 
			
		||||
        href: http://localhosdt/
 | 
			
		||||
        description: Homepage is the best
 | 
			
		||||
 | 
			
		||||
    - File Browser:
 | 
			
		||||
        icon: filebrowser.png
 | 
			
		||||
        href: "#"
 | 
			
		||||
        description: Media File Management
 | 
			
		||||
        server: my-docker
 | 
			
		||||
        container: filebrowser
 | 
			
		||||
 | 
			
		||||
- Utilities:
 | 
			
		||||
    - Media Portainer:
 | 
			
		||||
        icon: portainer.png
 | 
			
		||||
        href: http://portainer.home:9443/
 | 
			
		||||
        description: Container management
 | 
			
		||||
        server: my-docker
 | 
			
		||||
        container: portainer
 | 
			
		||||
        widget:
 | 
			
		||||
          type: portainer
 | 
			
		||||
          url: https://portainer.home:9443
 | 
			
		||||
          env: 2
 | 
			
		||||
          key: accesskeyaccesskeyaccesskeyaccesskey
 | 
			
		||||
 | 
			
		||||
    - Traefik:
 | 
			
		||||
        icon: traefik.png
 | 
			
		||||
        href: http://traefik.home/
 | 
			
		||||
        description: Reverse Proxy
 | 
			
		||||
        server: my-docker
 | 
			
		||||
        container: traefik
 | 
			
		||||
- My Third Group:
 | 
			
		||||
    - My Third Service:
 | 
			
		||||
        href: http://localhosdt/
 | 
			
		||||
        description: Homepage is 😎
 | 
			
		||||
 | 
			
		||||
@ -1,18 +1,7 @@
 | 
			
		||||
- weather: # type of the widget
 | 
			
		||||
    latitude: 51.5072 # widget configuration
 | 
			
		||||
    longitude: 0.1275
 | 
			
		||||
    units: metric
 | 
			
		||||
    apiKey: weather_api_key # get from https://www.weatherapi.com/
 | 
			
		||||
    cache: 5 # cache time in minutes
 | 
			
		||||
 | 
			
		||||
- openweathermap:
 | 
			
		||||
    latitude: 51.5072 # widget configuration
 | 
			
		||||
    longitude: 0.1275
 | 
			
		||||
    units: metric
 | 
			
		||||
    apiKey: openweathermap_api_key # get from https://openweathermap.org/api
 | 
			
		||||
    cache: 10 # cache time in minutes
 | 
			
		||||
# For configuration options and examples, please see:
 | 
			
		||||
# https://github.com/benphelps/homepage/wiki/Information-Widgets
 | 
			
		||||
 | 
			
		||||
- resources:
 | 
			
		||||
    cpu: true
 | 
			
		||||
    memory: true
 | 
			
		||||
    disk: / # disk (path) to show usage for
 | 
			
		||||
    disk: /
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user