DapperDox/dapperdox

Example not working out of the box

wirthual opened this issue · 1 comments

I'm using Kubuntu 16.04, when I run the run_example.sh I dont see any overlay.

This solved my problem:
http://forum.dapperdox.io/t/authored-content-not-showing-in-example/72

Maybe worth fixing in the run_example.sh for others.

Ok I think I was a bit to fast here.

If you run run_example.sh directly as you download it, you don't see any overlay because the assets folder ist pointing to ./assets by default if I am right.

So if you want to see the overlays, make sure you point the assets folder to ./examples/overlay/assets by setting -assets-dir=./examples/overlay/assets in the run_example.sh

If you want to see the guides, make sure to point assets folder to ./examples/guides/assets by setting -assets-dir=./examples/guides/assets in the run_example.sh

This way you can also run the other provided examples.

However, this seems still to be an issue: http://forum.dapperdox.io/t/authored-content-not-showing-in-example/72

For me the run_example.sh like this

#!/usr/bin/env bash
./dapperdox \
    -spec-dir=examples/specifications/petstore/ \
    -bind-addr=0.0.0.0:3123 \
    -site-url=http://localhost:3123 \
    -spec-rewrite-url=petstore.swagger.io=PETSTORE.swagger.io \
    -log-level=trace \
    -force-specification-list=false \
    -theme=default  \
    #-tls-certificate=server.rsa.crt \
    #-tls-key=server.rsa.key \
    #-author-show-assets=true \
    -assets-dir=./examples/overlay/assets \
    #-proxy-path=/developer=https://developer.some-dev-site.com 

is not working. In order to make it work with overlays i need to change it like this:

#!/usr/bin/env bash
./dapperdox \
    -spec-dir=examples/specifications/petstore/ \
    -bind-addr=0.0.0.0:3123 \
    -site-url=http://localhost:3123 \
    -spec-rewrite-url=petstore.swagger.io=PETSTORE.swagger.io \
    -log-level=trace \
    -force-specification-list=false \
    -theme=default  \
    -assets-dir=./examples/overlay/assets \
    #-tls-certificate=server.rsa.crt \
    #-tls-key=server.rsa.key \
    #-author-show-assets=true \
    #-proxy-path=/developer=https://developer.some-dev-site.com 

Then you should see the overlays as expected.

Thanks for this project 👍