WIP: Rework Readme file #53

SnowMB · 2017-03-15T12:15:48Z

Complete rework of the readme file.

I tried getting clearer on many topics that raised questions in the past. Hope it's understandable.

Before it get's merge we should do changes to the update/unpack script and solve #23

Please review @pierreozoux

pierreozoux

I think that then, we can get rid of the .example folder, right?

pierreozoux · 2017-03-21T10:09:37Z

README.md

+Now you can access Nextcloud at http://localhost/ from your host system. To make your nextcloud installation available from the internet you must map the port of the container to your host:
+
+```console
+$ docker run -p 80:80 -d nextcloud


I'd prefer to avoid giving insecure instructions, and link to SSL instructions here. What is your opinion on that?

pierreozoux · 2017-03-21T10:21:29Z

@tilosp how did you add your commit on top?
I did checkout locally the PR, and pushed it, and now I have this: https://github.com/nextcloud/docker/commits/pr/53... Sorry for the mess :)

tilosp · 2017-03-21T11:02:49Z

@pierreozoux You need to push to the source branch of the pull request, in this case SnowMB:master.
Your mess is fixed 😃

tilosp · 2017-03-26T16:39:17Z

Closed and reopened to manually trigger a Travis build

SnowMB · 2017-04-05T07:59:44Z

@pierreozoux

We should keep the examples folder (I reference it quite a few times in the Readme). I would even like to extend in the future and maybe split it into subfolders.

On the SSL part: I wanted to show the important things step by step (Exposing port, adding database, adding volumes, adding encription). For tinkering in the local network, exposing port 80 is fine. But we can add some more warning text or so.

* Added theming. * Added information on apps and custom_apps folder.

SnowMB · 2017-04-25T12:04:14Z

Rebased the whole thing and adapted to #65.

Added a part on migrating. Content should be ready for merge, just have to rework same typos.

Please review @tilosp, @pierreozoux.

tilosp · 2017-04-26T10:02:10Z

README.md

+When using docker-compose:
+
+```console
+$ docker-compose up -d --pull


I can't find the --pull option in the docs https://docs.docker.com/compose/reference/up/

You're right, that slipped. Fixed

tilosp · 2017-04-26T10:13:56Z

We should wait for #65 to make it into the docker library before merging this PR.
And we need to update https://github.com/docker-library/docs/tree/master/nextcloud.

tilosp · 2017-05-04T05:52:33Z

README.md

 ```console
 $ docker pull nextcloud
+$ docker stop <your_nextcloud_container>
+$ docker rm <your_nextcloud_container>
 $ docker run -d nextcloud


we need to add -v webroot:/var/www/html because we need to persist the version.php in it for the new upgrade system

Yeah. I'll rework the non-compose commands to reflect actual use with volumes.

@tilosp I'm a bit confused right now. Do you mean the upgrade script needs the old installation to perform a propper upgrade?

What would happen if I just mount the folders listed below and then pull a newer image?

$ docker run -d nextcloud \ -v apps:/var/www/html/custom_apps \ -v config:/var/www/html/config \ -v data:/var/www/html/data \ -v theme:/var/www/html/themes/<YOUR_CUSTOM_THEME>

I think this:
It would not find any version.php and perform a "new installation" wich copies all the installation files but does not overwrite the existing data files.

The only problem might be, that occ:upgrade is not triggered.

We could fix this in the upgrade script or by simply remove suggesting fine grained volume control from the readme.

Have I missed something?

With the new upgrade system we need to always have the /var/www/html volume.
And if the user wants to have the data, config, apps or themes in a different volume he can additionally add the corresponding volume.

tilosp · 2017-05-10T07:42:45Z

README.md

+- `/var/www/html/custom_apps` installed / modified apps
+- `/var/www/html/config` local configuration
+- `/var/www/html/data` the actual data of your Nextcloud
+- `/var/www/html/theming` theming/branding


I think the folder is called themes

Indeed, where is my mind? ;)
But I need to rework that section, too. Mounting the whole folder is not necessary because of the examples folder. Also #72

Also added a line on upgrading.

topas-rec · 2017-05-15T17:55:55Z

Hello everyone,

I just found nextcloud beside owncloud and was really impressed - until I saw what was published regarding docker.
This readme update hooked me up again and I'll try to get it running. (The Apache image ran within a few minutes, but owncloud also gave me ssl and no security warnings in the admin menu - in a few minutes ;-))

Nice work - many thanks. I hope it gets released for everyone on the main page of docker soon.

It might help to change the words "your-name" in line 232 and 233 to "name of your container" but this is just cosmetics. I'll try to reply when I got it working or gave up. (I'm a perfect test object since my docker experience is 4 days joung)

tilosp · 2017-05-16T07:33:21Z

@pierreozoux please review

pierreozoux

Really nice work!
Beside the SSL part, I'm really happy, this looks promising! (And feel free to ignore my SSL comment if you feel like)

This work can inspire docker-library/docs#238

@tianon if you could also give a quick review, it would be nice!

Thanks @ALL

PS: it has to be squashed before merge

pierreozoux · 2017-05-16T11:39:31Z

README.md

+    volumes:
+      - db:/var/lib/mysql
+    environment:
+      - MYSQL_ROOT_PW=...


I'd remove the ..., then if you don't put anything, docker-compose throw an error (this is the desired behavior, people putting their own password, and not using any default.

pierreozoux · 2017-05-16T11:41:30Z

README.md


+```console
+$ docker run -p 80:80 -d nextcloud


As already said, I'm not a big fan to ease non secure deploy. If you want to keep this, I'd add a section "development/testing" where it explains how to map such insecure way. And this section should be after the SSL section.

Each part contains a line about how that setup does not contain ssl encryption, I can make it bold if you like 😁. Since nextcloud itself complains about unsecure connection when you connect via http, I think it should be fine.

But I'll have a look at removing port mappings from the example and move it to a new part as you proposed.

pierreozoux · 2017-05-16T11:41:55Z

README.md

+  app:  
+    image: nextcloud
+    ports:
+      - "80:80"


same comment as above about the insecure deploy

pierreozoux · 2017-05-16T11:42:04Z

README.md

+  web:
+    image: nginx
+    ports:
+      - "80:80"


same comment as above about the insecure deploy

pierreozoux · 2017-05-16T11:43:39Z

README.md

+
+
+# Adding Features
+A lot of people want use additional functionality inside their nextcloud installation. If the image does not include the packages you need, you can easily build your own image on top of it.


want to use

SnowMB · 2017-05-17T09:58:44Z

Yeah definetly squash merge. 😀

SnowMB · 2017-05-17T11:07:46Z

@pierreozoux Adressed your review. I removed all port mappings from the examples and created a new section called Connect your Nextcloud to the internet. This should remove your concerns 😄.

pierreozoux

I think we are good to go :) Thanks a lot for the efforts!

topas-rec · 2017-05-18T19:31:24Z

Hello everyone,

I sent some time testing the example (docker compose). I would like to give feedback and talk about an error of the setup.
Feedback first:

I didn't know that I have (or am allowed) to change the docker compose file.
I didn't know that I have to set passwords of the db container.
I didn't knew what to download from the .example directory. I took all files. I started sudo docker-compose up (sudo because I didn't setup groups for docker - I'm personally fine with using sudo)
I wasn't able to set the environmental variable DOMAIN from the docker compose file in the docker command so I changed it in the docker compose file. (I didn''t knew this)
I had to figure out myself that I need to set a valid domain name - localhost didn't worked for me.
I didn't knew that a valid email is necessary for lets encrypt

After fixing these things I got mostly all services up and running.

Now to one issue that I have after I was able to reach the proxy via my ddns (no-ip) domain:
THe nginx web server - not the proxy - shows the following errors when a client connects:

PHP message: {"reqId":"J8dbbzhk41yQ6bR4\/K\/+","remoteAddr":"172.18.0.6","app":"PHP","message":"fopen(\/var\/www\/html\/config\/config.php): failed to open stream: No such file or directory at \/var\/www\/html\/lib\/private\/Config.php#230","level":3,"time":"2017-05-18T19:09:06+00:00","method":"GET","url":"\/","user":"--","version":""} PHP message: {"reqId":"J8dbbzhk41yQ6bR4\/K\/+","remoteAddr":"172.18.0.6","app":"PHP","message":"chmod(): No such file or directory at \/var\/www\/html\/lib\/private\/Config.php#233","level":3,"time":"2017-05-18T19:09:06+00:00","method":"GET","url":"\/","user":"--","version":""}" while reading response header from upstream, client: 172.18.0.6, server: , request: "GET / HTTP/1.1", upstream: "fastcgi://172.18.0.3:9000", host: "[...].ddns.net" 2017/05/18 19:09:06 [error] 5#5: *1 FastCGI sent in stderr: "PHP message: {"reqId":"J8dbbzhk41yQ6bR4\/K\/+","remoteAddr":"172.18.0.6","app":"PHP","message":"chmod(): No such file or directory at \/var\/www\/html\/lib\/private\/Log\/File.php#119","level":3,"time":"2017-05-18T19:09:06+00:00","method":"GET","url":"\/","user":"--","version":""}" while reading upstream, client: 172.18.0.6, server: , request: "GET / HTTP/1.1", upstream: "fastcgi://172.18.0.3:9000", host: "[...].ddns.net" 2017/05/18 19:11:08 [error] 5#5: *56 FastCGI sent in stderr: "PHP message: {"reqId":"tJuu66dEOjjKrdvZuVC3","remoteAddr":"172.18.0.1","app":"PHP","message":"touch(): Unable to create file \/var\/www\/html\/config\/config.php because Permission denied at \/var\/www\/html\/lib\/private\/Config.php#229","level":3,"time":"2017-05-18T19:11:08+00:00","method":"GET","url":"\/","user":"--","version":""} PHP message: {"reqId":"tJuu66dEOjjKrdvZuVC3","remoteAddr":"172.18.0.1","app":"PHP","message":"fopen(\/var\/www\/html\/config\/config.php): failed to open stream: No such file or directory at \/var\/www\/html\/lib\/private\/Config.php#230","level":3,"time":"2017-05-18T19:11:08+00:00","method":"GET","url":"\/","user":"--","version":""} PHP message: {"reqId":"tJuu66dEOjjKrdvZuVC3","remoteAddr":"172.18.0.1","app":"PHP","message":"chmod(): No such file or directory at \/var\/www\/html\/lib\/private\/Config.php#233","level":3,"time":"2017-05-18T19:11:08+00:00","method":"GET","url":"\/","user":"--","version":""}" while reading response header from upstream, client: 172.18.0.1, server: , request: "GET / HTTP/1.1", upstream: "fastcgi://172.18.0.3:9000", host: "172.18.0.2"

The (well known blue) nextcloud page appears on the clients web browser but shows: `Can't write into config directory!

This can usually be fixed by giving the webserver write access to the config directory.`

This looks like wrong permissions inside the container. (I usually would spend more time with it but I think your docker experience is better than mine and I think others would also profit from this information)

Can you help me on that and extend the readme file or an examples documentation for the things which cannot be found in an existing manual (like setting correct env vars)

topas-rec · 2017-05-18T19:40:17Z

I just thought that my error has to do with the missing groups setting on my docker host (I have to use sudo before every docker command) but I made the owncloud image work in a container and the nextcloud Apache image also works with these settings.

topas-rec · 2017-05-18T20:27:25Z

Okay, I found this in the docker-compose file:

volumes: - ./nginx.conf:/etc/nginx/nginx.conf:ro
I assume 'ro' stands for read only. I wasn't able to test this. If you don't have other ideas I guess this might cause the issue. If so - why am I the only one having this issue?

I'll test this as soon as possible.

topas-rec · 2017-05-18T20:42:19Z

Another possible cause: greyltc/docker-owncloud#74

topas-rec · 2017-05-19T20:05:00Z

I've tested the :Z option at the config directory. That doesn't help.
I've also tried to remove the :ro option without success.
Can someone give me an idea where to continue troubleshooting? Should I create an issue because this is not directly related to the readme update?

SnowMB · 2017-05-20T09:29:41Z

Hey,

thanks for your feedback!

 I didn't know that I have (or am allowed) to change the docker compose file.

A compose file is a very specialized description of your services. It indeed has to be adapted to your needs.

 I didn't know that I have to set passwords of the db container.

Hm sorry, but I thought that's obvious 😁. I might add a line.

 I didn't knew what to download from the .example directory. I took all files. I started sudo docker-compose up (sudo because I didn't setup groups for docker - I'm personally fine with using sudo)

I think we'll have to structure the examples directory. If noone else does it I'll have a look when we finished the new Readme 😄.

 I wasn't able to set the environmental variable DOMAIN from the docker compose file in the docker command so I changed it in the docker compose file. (I didn''t knew this)

I don't know what variable you mean. There's just a VIRTUAL_HOST for the proxy and a LETSENCRYPT_HOST and LETSENCRYPT_EMAIL for letsencrypt. There is good documentation in the respective repos proxy and letsencrypt.

 I had to figure out myself that I need to set a valid domain name - localhost didn't worked for me.
 I didn't knew that a valid email is necessary for lets encrypt

This both has to do with the way letsencrypt and the reverse proxy work. As I said, these projects already have a good documentation, so I don't think it is necessary for us to give more information on that. We might add links to the repos tho.

#To your error:
You have a permission error on the /var/www/html/config directory.
It does not seem to be related to the nginx.conf file. So your tries to fix this where at the wrong place.

Please open an issue to get more help. This PR is just about the rework of the Readme and we would like to avoid any clutter that's unrelated to the topic. 👍

topas-rec · 2017-05-22T05:15:54Z

Hello,

Links to the documentation would be nice and I think helpful.
I'll open an issue for the permission problem.

Thanks and regards

tilosp · 2017-05-23T19:28:58Z

@SnowMB is this PR ready for merge

SnowMB · 2017-05-23T21:34:25Z

Yeah should be. For now I think it's ok. Further improvements can be be done in new PRs. People are already confused about the old Readme. Will you do the merge?

pierreozoux reviewed Mar 21, 2017

View reviewed changes

tilosp mentioned this pull request Mar 26, 2017

Explain examples #58

Closed

tilosp closed this Mar 26, 2017

tilosp reopened this Mar 26, 2017

SnowMB and others added 7 commits April 25, 2017 11:05

Rework Readme file

14c1dd5

Fixed db-folder paths

6781f2e

Typos

9092010

Fixed Typos

4326b28

Fix typo

7208308

Use pull to correctly pull a newer base image

7bd5811

Moved heading to the top

ed983ba

SnowMB force-pushed the master branch from 35e8658 to ed983ba Compare April 25, 2017 09:13

SnowMB added 4 commits April 25, 2017 11:57

Clarify serving of static files in the fpm container

cf23653

Update Persistant data

2e1b0e2

* Added theming. * Added information on apps and custom_apps folder.

Typos, clarification

f65aaef

Added migration part

dae002d

tilosp reviewed Apr 26, 2017

View reviewed changes

SnowMB added 2 commits April 26, 2017 13:18

Fix wrong use of --pull

3ab0270

Reordering, spelling, clarification

5af009d

tilosp reviewed May 4, 2017

View reviewed changes

tilosp mentioned this pull request May 4, 2017

Apps Persistence not fully working #68

Closed

tilosp requested changes May 10, 2017

View reviewed changes

SnowMB added 2 commits May 11, 2017 17:45

Specified volumes section

58bd10f

Corrected examples

0c02c82

tilosp mentioned this pull request May 13, 2017

Port running on 80 instead of 9000 #74

Closed

SnowMB added 2 commits May 15, 2017 11:42

Added /var/www/html to the fine grained volume approach

eef2752

Also added a line on upgrading.

Typos in migration section

391e902

tilosp approved these changes May 16, 2017

View reviewed changes

pierreozoux requested changes May 16, 2017

View reviewed changes

SnowMB added 3 commits May 17, 2017 12:45

Updated SSL-encryption, Typos, removed "..."

dc57691

Typos and some layout improvements

90cbc02

Typo, typo, typo :D

6ff1685

pierreozoux approved these changes May 17, 2017

View reviewed changes

SnowMB added 2 commits May 23, 2017 00:05

Added hint to set passwords

98be678

added links for external containers in ssl example

00f8f36

SnowMB mentioned this pull request May 23, 2017

Permission denied error for config directory in examples #75

Closed

tilosp merged commit f8a4572 into nextcloud:master May 24, 2017

tilosp mentioned this pull request Jun 7, 2017

Rework of the nextcloud readme file docker-library/docs#929

Merged



		# Adding Features
		A lot of people want use additional functionality inside their nextcloud installation. If the image does not include the packages you need, you can easily build your own image on top of it.

WIP: Rework Readme file #53

WIP: Rework Readme file #53

Conversation

SnowMB commented Mar 15, 2017

pierreozoux left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pierreozoux commented Mar 21, 2017

tilosp commented Mar 21, 2017 • edited Loading

tilosp commented Mar 26, 2017

SnowMB commented Apr 5, 2017

SnowMB commented Apr 25, 2017

tilosp Apr 26, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tilosp commented Apr 26, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SnowMB May 10, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

topas-rec commented May 15, 2017 • edited Loading

tilosp commented May 16, 2017

pierreozoux left a comment

Choose a reason for hiding this comment

pierreozoux May 16, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SnowMB May 17, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SnowMB commented May 17, 2017

SnowMB commented May 17, 2017

pierreozoux left a comment

Choose a reason for hiding this comment

topas-rec commented May 18, 2017 • edited Loading

topas-rec commented May 18, 2017 • edited Loading

topas-rec commented May 18, 2017 • edited Loading

topas-rec commented May 18, 2017

topas-rec commented May 19, 2017

SnowMB commented May 20, 2017 • edited Loading

topas-rec commented May 22, 2017

tilosp commented May 23, 2017

SnowMB commented May 23, 2017

tilosp commented Mar 21, 2017 •

edited

Loading

tilosp Apr 26, 2017 •

edited

Loading

SnowMB May 10, 2017 •

edited

Loading

topas-rec commented May 15, 2017 •

edited

Loading

pierreozoux May 16, 2017 •

edited

Loading

SnowMB May 17, 2017 •

edited

Loading

topas-rec commented May 18, 2017 •

edited

Loading

topas-rec commented May 18, 2017 •

edited

Loading

topas-rec commented May 18, 2017 •

edited

Loading

SnowMB commented May 20, 2017 •

edited

Loading