Feedback for “Docker Compose” Documentation

[Kaszanas]

Currently "Edit this page" button does not work.

Additionally upon copying the example docker-compose file, there are a few tab indentations within the file.

This is most likely an issue with the copying mechanism. The indentations break and need to be fixed manually to achieve correct syntax.

Copied example:

services:
  postiz:
  	image: ghcr.io/gitroomhq/postiz-app:latest
	container_name: postiz
	restart: always
	volumes:
	  - ./config:/config/ # Should contain your .env file
	ports:
	  - 4200:4200
	  - 3000:3000
	networks:
	  - postiz-network
 
  postiz-postgres:
    image: postgres:14.5
    container_name: postiz-postgres
    restart: always
    environment:
      POSTGRES_PASSWORD: postiz-local-pwd
      POSTGRES_USER: postiz-local
      POSTGRES_DB: postiz-db-local
    volumes:
      - postgres-volume:/var/lib/postgresql/data
    ports:
      - 5432:5432
    networks:
      - postiz-network
  postiz-pg-admin:
    image: dpage/pgadmin4
    container_name: postiz-pg-admin
    restart: always
    ports:
      - 8081:80
    environment:
      PGADMIN_DEFAULT_EMAIL: [email protected]
      PGADMIN_DEFAULT_PASSWORD: admin
    networks:
      - postiz-network
  postiz-redis:
    image: redis:7.2
    container_name: postiz-redis
    restart: always
    ports:
      - 6379:6379
 
volumes:
  postgres-volume:
    external: false
 
networks:
  postiz-network:
    external: false

Correct syntax:

services:
  postiz:
    image: ghcr.io/gitroomhq/postiz-app:latest
    container_name: postiz
    restart: always
    volumes:
      - ./config:/config/ # Should contain your .env file
    ports:
      - 4200:4200
      - 3000:3000
    networks:
      - postiz-network
 
  postiz-postgres:
    image: postgres:14.5
    container_name: postiz-postgres
    restart: always
    environment:
      POSTGRES_PASSWORD: postiz-local-pwd
      POSTGRES_USER: postiz-local
      POSTGRES_DB: postiz-db-local
    volumes:
      - postgres-volume:/var/lib/postgresql/data
    ports:
      - 5432:5432
    networks:
      - postiz-network
  postiz-pg-admin:
    image: dpage/pgadmin4
    container_name: postiz-pg-admin
    restart: always
    ports:
      - 8081:80
    environment:
      PGADMIN_DEFAULT_EMAIL: [email protected]
      PGADMIN_DEFAULT_PASSWORD: admin
    networks:
      - postiz-network
  postiz-redis:
    image: redis:7.2
    container_name: postiz-redis
    restart: always
    ports:
      - 6379:6379
 
volumes:
  postgres-volume:
    external: false
 
networks:
  postiz-network:
    external: false

[nevo-david]

@jamesread can you have a look?

[jamesread]

Yep, assign to me and I'll fix this evening.

[Kaszanas]

@nevo-david @jamesread

It would be great to receive more information on configuring and fast local deployment of the app as well.

I got Postiz running locally by following the: https://docs.postiz.com/installation/development

Otherwise following the Docker Compose: https://docs.postiz.com/installation/docker-compose didn't work as expected. Generating prisma schema and applying DB changes couldn't find the .env file. Based on that I think that the requirement for node is that the .env needs to be placed in the main directory and not as defined in docker compose in /config

What is the preferred way of running this software for testing locally?
Does Postiz support private LinkedIn pages? The instructions show how to obrain a client_id, and the LinkedIn developers page requires to add it to a certain company page.

I'd be happy to contribute some technical documentation, currently I cannot find sufficient information to reliably test locally.

Google OAuth failed to work (client_id) missing. Other routes seem to have the same issue (these values are not set in .env), and their importance is unknown.

[nevo-david]

The docker is new and needs more work - we would be happy if you could help us.
The local is the default.
Postiz has both private and company Linkedin pages, but docs needs to be worked out more

[Kaszanas]

@nevo-david I will join Discord and discuss with you. I would need to understand the app more to write up parts of the docs, and I would have to know what is the preferred workflow.

[jamesread]

@Kaszanas I actually made quite a few improvements about 24 hours ago, but they got lost in the migration to the new docs system.

I'm actually doing a full end to end test on a clean Ubuntu VM now, and I've reimplemented some of those changes, but I've much-improved the docker compose docs. Annoyingly I cannot push the doc changes because I don't have access to the new repository yet!

I also found one bug in the container, which I've just patched, and I'm building new container images now.

[Kaszanas]

@jamesread thanks for the information.

If you point me towards a branch I could have a look. Anyway I'll be testing the app further in the upcoming days and if I find anything stick outb I'll let you know!

[jamesread]

Save yourself a bit of effort and wait til tomorrow, you'll see some major improvements in docs!

…

On Sun, 15 Sep 2024, at 23:43, Kaszanas wrote: @jamesread <https://github.com/jamesread> thanks for the information. If you point me towards a branch I could have a look. Anyway I'll be testing the app further in the upcoming days and if I find anything stick outb I'll let you know! — Reply to this email directly, view it on GitHub <#238 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAPOR422XVXXZ6J5V6HILN3ZWYEPXAVCNFSM6AAAAABOH5CSYGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGNJRHAYTQMRYHE>. You are receiving this because you were mentioned.Message ID: ***@***.***>

--- James Read web: http://jread.com tel: +44 (0)7899 688 226 mail: ***@***.***

[jamesread]

Save yourself some effort now and wait til tomorrow, you'll see some major improvements in docs! :-)

[Kaszanas]

Save yourself some effort now and wait til tomorrow, you'll see some major improvements in docs! :-)

Thanks!

The improvements seem to be online.

But the routing seems broken.

route: https://docs.postiz.com/installation/kubernetes-helm is still available and shows:

Then when "Docker" is clicked it changes to this:

There are more instances of such behavior, but it is impossible to describe them in text reliably. Only some navigation buttons cause this.

[jamesread]

Yeah, this was due to some weird caching issues on Vercel, which Nevo seems to have fixed now. gitroomhq/postiz-docs#4

I've just made some pretty big changes to docker compose, @Kaszanas , could you take another look and see how it looks now?

[Kaszanas]

@jamesread Sure thing, where should I look for the fresh docker compose ;)?

[jamesread]

We had a long chat on discord, and made one or two extra tweaks so nothing else from this issue should be open.

Let's keep docs improvements going in new issues. :-)