https://github.com/tomershvueli/homepage

A simple, standalone, self-hosted PHP page that is your window to your server and the web.
https://github.com/tomershvueli/homepage

homepage minimal php self-hosted

Last synced: 2 months ago
JSON representation

A simple, standalone, self-hosted PHP page that is your window to your server and the web.

• Host: GitHub
• URL: https://github.com/tomershvueli/homepage
• Owner: tomershvueli
• License: mit
• Created: 2016-09-04T02:44:59.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2021-05-09T18:11:15.000Z (over 3 years ago)
• Last Synced: 2024-08-03T11:09:26.600Z (5 months ago)
• Topics: homepage, minimal, php, self-hosted
• Language: JavaScript
• Homepage:
• Size: 25.2 MB
• Stars: 304
• Watchers: 13
• Forks: 29
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Homepage

[![Mentioned in Awesome Selfhosted](https://awesome.re/mentioned-badge.svg)](https://github.com/Kickball/awesome-selfhosted#personal-dashboards)

This project is a simple, standalone, self-hosted PHP page that is meant to be your window to your server and the web. 

It is your minimalist corner of the internet. The background will update with a gorgeous (and royalty free) image from [Unsplash](https://unsplash.com/), or a custom source every 20 seconds. With it, a simple menu is available to you with your most frequented links. 

All the assets needed are part of the repo so it can run offline (though it won't fetch pretty background images for you). 

This project uses:

- Apache

- PHP and PHP cURL

- jQuery

- Bootstrap CSS

- Mousetrap.js

- Font Awesome

- Unsplash

## Screenshots

Homepage w/o Menu:

![Homepage w/o Menu](example_img/homepage-wo-menu.png?raw=true)

Homepage with Menu Toggled:

![Homepage with Menu](example_img/homepage-w-menu.png?raw=true)

## To Use

Copy the config.sample.json file and rename to config.json. Be sure to update the fields as you see appropriate. You have the option to use the Unsplash API to fetch background images, or use a custom URL and JSON selector. If you choose to use Unsplash, will need to create a developer profile at [Unsplash](https://unsplash.com/) to use the background image functionality properly. 

## Configure Homepage

- `unlock_pattern` => Choose unlock pattern from [Mousetrap](https://craig.is/killing/mice)

- `clock_format` => Choose pattern format from [PHP's date function](http://php.net/manual/en/function.date.php)

- `hover_color` => The CSS color for menu items when hovered over. Defaults to `#999`. 

- `time_to_refresh_bg` => Time, in milliseconds, until it will fetch the next background image. Defaults to `20000`. 

- `show_menu_on_page_load` => Boolean as to whether the menu should be shown when you first load the page. Defaults to `false`.

- `idle_timer` => Set a number of milliseconds here if you'd like to automatically hide the menu after a certain time of inactivity. Leave this attribute out entirely if you don't want an idle timer. 

- `items` => Array of objects for links to be displayed. The menu will be in a grid of 3 icons per row on desktop. Object shape: 

  - `link` => Insert any link you'd like, or {{cur}} for the current URL of the page, i.e. `{{cur}}:32400/web/`. 

  - `icon` => Icon to be displayed, choose icons from [Font Awesome](http://fontawesome.io/icons/). 

  - `img` => Image to be displayed in place of an icon. Place image in `hp_assets/img` directory. Image will be displayed in size 80px x 80px. 

  - `alt` => Value for `title` of anchor tag. 

  - `new_tab` => Optional boolean value for whether link should open in new tab or current tab. 

__NOTE__: PHP cURL is required for fetching external images.

### Unsplash Background Images

- `unsplash_client_id` => Get Unsplash client ID from [Unsplash](https://unsplash.com/developers)

__NOTE__: There [have been reports](https://github.com/tomershvueli/homepage/issues/24#issuecomment-754450034) that applying for a Normal API upgrading from a demo API will result in Unsplash shutting down your API key entirely. I suggest sticking to the demo API key and setting the `time_to_refresh_bg` config variable to `90000`. This will ensure that you don't surpass the 50 hourly requests that Unsplash provides for demo API keys. Or feel free to use a custom background image (see below). 

### Custom Background Images

- `custom_url` => Input a custom URL that will return proper JSON. Supports `{{cur}}` substitution for current URL. 

- `custom_url_headers` => Add any headers that may be needed to complete a cURL request to the aforementioned URL properly

- `custom_url_selector` => Input a proper PHP array selector to be used on the JSON received above. For example, if I were to fetch from Github's user API with a 'custom_url' of 'https://api.github.com/users/octocat', the 'custom_url_selector' would simply be `['avatar_url']`. `[{random}]` can be replaced for a random index in an array. 

## Supporting

If you enjoy homepage and want to support the project, you can buy me a Ko-Fi! 

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D41JRJE)

Or, feel free to [contribute to homepage](CONTRIBUTING.md) by creating a PR to expand on features that you think are missing!