|
1 | 1 | <p align="center"><em>What if you could see everything at a...</em></p>
|
2 | 2 | <h1 align="center">Glance</h1>
|
3 |
| -<p align="center"><a href="#installation">Install</a> • <a href="docs/configuration.md">Configuration</a> • <a href="docs/preconfigured-pages.md">Preconfigured pages</a> • <a href="docs/themes.md">Themes</a> • <a href="https://discord.com/invite/7KQ7Xa9kJd">Discord</a></p> |
| 3 | +<p align="center"><a href="#installation">Install</a> • <a href="docs/configuration.md">Configuration</a> • <a href="https://discord.com/invite/7KQ7Xa9kJd">Discord</a> • <a href="https://github.com/sponsors/glanceapp">Sponsor</a></p> |
| 4 | +<p align="center"><a href="https://github.com/glanceapp/community-widgets">Community widgets</a> • <a href="docs/preconfigured-pages.md">Preconfigured pages</a> • <a href="docs/themes.md">Themes</a></p> |
4 | 5 |
|
5 | 6 | 
|
6 | 7 |
|
@@ -194,6 +195,7 @@ services:
|
194 | 195 | glance:
|
195 | 196 | container_name: glance
|
196 | 197 | image: glanceapp/glance
|
| 198 | + restart: unless-stopped |
197 | 199 | volumes:
|
198 | 200 | - ./config:/app/config
|
199 | 201 | ports:
|
@@ -264,59 +266,31 @@ Glance can also be installed through the following 3rd party channels:
|
264 | 266 |
|
265 | 267 | <br>
|
266 | 268 |
|
267 |
| -## Building from source |
268 |
| - |
269 |
| -Choose one of the following methods: |
270 |
| - |
| 269 | +## Common issues |
271 | 270 | <details>
|
272 |
| -<summary><strong>Build binary with Go</strong></summary> |
273 |
| -<br> |
274 |
| - |
275 |
| -Requirements: [Go](https://go.dev/dl/) >= v1.23 |
276 |
| - |
277 |
| -To build the project for your current OS and architecture, run: |
278 |
| - |
279 |
| -```bash |
280 |
| -go build -o build/glance . |
281 |
| -``` |
| 271 | +<summary><strong>Requests timing out</strong></summary> |
282 | 272 |
|
283 |
| -To build for a specific OS and architecture, run: |
| 273 | +The most common cause of this is when using Pi-Hole, AdGuard Home or other ad-blocking DNS services, which by default have a fairly low rate limit. Depending on the number of widgets you have in a single page, this limit can very easily be exceeded. To fix this, increase the rate limit in the settings of your DNS service. |
284 | 274 |
|
285 |
| -```bash |
286 |
| -GOOS=linux GOARCH=amd64 go build -o build/glance . |
287 |
| -``` |
288 |
| - |
289 |
| -[*click here for a full list of GOOS and GOARCH combinations*](https://go.dev/doc/install/source#:~:text=$GOOS%20and%20$GOARCH) |
290 |
| - |
291 |
| -Alternatively, if you just want to run the app without creating a binary, like when you're testing out changes, you can run: |
292 |
| - |
293 |
| -```bash |
294 |
| -go run . |
| 275 | +If using Podman, in some rare cases the timeout can be caused by an unknown issue, in which case it may be resolved by adding the following to the bottom of your `docker-compose.yml` file: |
| 276 | +```yaml |
| 277 | +networks: |
| 278 | + podman: |
| 279 | + external: true |
295 | 280 | ```
|
296 |
| -<hr> |
297 | 281 | </details>
|
298 | 282 |
|
299 | 283 | <details>
|
300 |
| -<summary><strong>Build project and Docker image with Docker</strong></summary> |
301 |
| -<br> |
302 |
| - |
303 |
| -Requirements: [Docker](https://docs.docker.com/engine/install/) |
304 |
| - |
305 |
| -To build the project and image using just Docker, run: |
| 284 | +<summary><strong>Broken layout for markets, bookmarks or other widgets</strong></summary> |
306 | 285 |
|
307 |
| -*(replace `owner` with your name or organization)* |
308 |
| - |
309 |
| -```bash |
310 |
| -docker build -t owner/glance:latest . |
311 |
| -``` |
| 286 | +This is almost always caused by the browser extension Dark Reader. To fix this, disable dark mode for the domain where Glance is hosted. |
| 287 | +</details> |
312 | 288 |
|
313 |
| -If you wish to push the image to a registry (by default Docker Hub), run: |
| 289 | +<details> |
| 290 | +<summary><strong>cannot unmarshal !!map into []glance.page</strong></summary> |
314 | 291 |
|
315 |
| -```bash |
316 |
| -docker push owner/glance:latest |
317 |
| -``` |
| 292 | +The most common cause of this is having a `pages` key in your `glance.yml` and then also having a `pages` key inside one of your included pages. To fix this, remove the `pages` key from the top of your included pages. |
318 | 293 |
|
319 |
| -<hr> |
320 | 294 | </details>
|
321 | 295 |
|
322 | 296 | <br>
|
@@ -375,6 +349,63 @@ Feature requests are tagged with one of the following:
|
375 | 349 |
|
376 | 350 | <br>
|
377 | 351 |
|
| 352 | +## Building from source |
| 353 | + |
| 354 | +Choose one of the following methods: |
| 355 | + |
| 356 | +<details> |
| 357 | +<summary><strong>Build binary with Go</strong></summary> |
| 358 | +<br> |
| 359 | + |
| 360 | +Requirements: [Go](https://go.dev/dl/) >= v1.23 |
| 361 | + |
| 362 | +To build the project for your current OS and architecture, run: |
| 363 | + |
| 364 | +```bash |
| 365 | +go build -o build/glance . |
| 366 | +``` |
| 367 | + |
| 368 | +To build for a specific OS and architecture, run: |
| 369 | + |
| 370 | +```bash |
| 371 | +GOOS=linux GOARCH=amd64 go build -o build/glance . |
| 372 | +``` |
| 373 | + |
| 374 | +[*click here for a full list of GOOS and GOARCH combinations*](https://go.dev/doc/install/source#:~:text=$GOOS%20and%20$GOARCH) |
| 375 | + |
| 376 | +Alternatively, if you just want to run the app without creating a binary, like when you're testing out changes, you can run: |
| 377 | + |
| 378 | +```bash |
| 379 | +go run . |
| 380 | +``` |
| 381 | +<hr> |
| 382 | +</details> |
| 383 | + |
| 384 | +<details> |
| 385 | +<summary><strong>Build project and Docker image with Docker</strong></summary> |
| 386 | +<br> |
| 387 | + |
| 388 | +Requirements: [Docker](https://docs.docker.com/engine/install/) |
| 389 | + |
| 390 | +To build the project and image using just Docker, run: |
| 391 | + |
| 392 | +*(replace `owner` with your name or organization)* |
| 393 | + |
| 394 | +```bash |
| 395 | +docker build -t owner/glance:latest . |
| 396 | +``` |
| 397 | + |
| 398 | +If you wish to push the image to a registry (by default Docker Hub), run: |
| 399 | + |
| 400 | +```bash |
| 401 | +docker push owner/glance:latest |
| 402 | +``` |
| 403 | + |
| 404 | +<hr> |
| 405 | +</details> |
| 406 | + |
| 407 | +<br> |
| 408 | + |
378 | 409 | ## Contributing guidelines
|
379 | 410 |
|
380 | 411 | * Before working on a new feature it's preferable to submit a feature request first and state that you'd like to implement it yourself
|
|
0 commit comments