docs icon indicating copy to clipboard operation
docs copied to clipboard

[Installation] Add example to run the server

Open jaiakash opened this issue 3 years ago • 3 comments

Screenshot from 2022-01-07 01-51-29

For https://appwrite.io/docs/installation page, last part. I suggest adding an example screenshot for running the server for the first time. Like personally I faced this issue, I executed the command but did notice to run the link on the browser. Like "Manual (using docker-compose.yml)" has a title, running the server should also have

  • [ ] A separate title
  • [ ] A screenshot

And yeah, I would love to contribute to this issue.

jaiakash avatar Jan 06 '22 20:01 jaiakash

I am sorry, I didn't fully understand this. What exactly is the issue with these docs? What steps are missing? What title needs to be added?

For the screenshot, I believe we don't use screenshots in our docs, we try to explain everything properly in the text. We would like to stay consistent about these things.

Meldiron avatar Jan 07 '22 12:01 Meldiron

What title needs to be added?

For running the server. There is no title for running the server, but there is title for "system requirements", "installation", etc.

For the screenshot, I believe we don't use screenshots in our docs, we try to explain everything properly in the text. We would like to stay consistent about these things.

I understand, then can we use code snippet to open the server, localhost:89

jaiakash avatar Jan 07 '22 18:01 jaiakash

I'm not sure this should be added or changed. This is for people manually running Appwrite with Docker Compose, who I'd expect would know what to look for once running the application. A guide that explains this step by step could be written, but that would involve rewriting a lot of generic Docker instructions in running it with Appwrite. I'd expect anyone without much Docker development experience to use the primary example that first comes up when you hit the Get Started button.

docker run -it --rm \
    --volume /var/run/docker.sock:/var/run/docker.sock \
    --volume "$(pwd)"/appwrite:/usr/src/code/appwrite:rw \
    --entrypoint="install" \
    appwrite/appwrite:1.1.0

loftwah avatar Nov 25 '22 07:11 loftwah