diff --git a/docs/cors.md b/docs/cors.md new file mode 100644 index 000000000..192da5af7 --- /dev/null +++ b/docs/cors.md @@ -0,0 +1,21 @@ +# Cross Origin Resource Sharing (CORS) + +## Chrome Workaround + +For the Chrome you can use the following plugin that allows you toggle CORS: +[Allow-Control-Allow-Origin](https://chrome.google.com/webstore/detail/allow-control-allow-origi/nlfbmbojpeacfghkpbjhddihlkkiljbi) + +## Firefox Workaround + +FireFox users can try the following plugin: [CORS Everywhere](https://addons.mozilla.org/en-Gb/firefox/addon/cors-everywhere/) + +## Safari Workaround + +If you are developing or testing with Safari then you can use the "Develop" menu to toggle the CORS mode. +Please note that page must be reloaded every time you change CORS settings. + + + +## See also + +- [Using CORS](https://www.html5rocks.com/en/tutorials/cors/) diff --git a/docs/docker.md b/docs/docker.md new file mode 100644 index 000000000..8f24330cc --- /dev/null +++ b/docs/docker.md @@ -0,0 +1,88 @@ +# Using with Docker + +
+This article assumes you are familiar with Docker and know how to create images and containers. +
+ +You can create a Docker image to run Alfresco Content App in the container. + +## Building from source code + +You need to run the following commands to build the project from the source code: + +```sh +npm install +npm run build +``` + +That produces a build in the "dist" folder that you can use with a Docker image. + ++Also, you may need to update the `dist/app.config.json` file with the settings relevant to your scenario. +
+ +## Creating an image + +The Content Application provides a "Dockerfile" file in the repository root. +You can build the image with the following command: + +```sh +docker image build -t content-app . +``` + +## Running image in a container + +To run the image locally, you can use the following command: + +```sh +docker container run -p 80:80 --rm content-app +``` + +Navigate to "http://localhost" to access the running application. + +## Docker Compose file + +You can also use the "docker-compose" file for local development and testing. +To build and run container run the following command in the root project folder: + +```sh +docker-compose up +``` + +To perform a cleanup operation, use the next command: + +```sh +docker-compose down --rmi all +``` + +Navigate to "http://localhost:3000" to access the running application. + ++Please keep in mind that you should manually build the project every time you want to publish the image or run it locally with the container. +
+ +## Using with local ACS setup + +If you run ACS at port 8080 as a Docker container (typical development configuration), you can use the following command to build the project before creating an image: + +```sh +npm run build:dev +``` + +The command above updates the "dist/app.config.json" file to point the Content App to "http://localhost:8080" upon startup. +Alternatively, you can change the configuration file manually before generating an image. + +So the development workflow, in this case, is going to be: + +```sh +npm run build:dev +docker-compose up +``` + +Navigate to "http://localhost:3000" to access the running application. + +To perform a cleanup operation, use the next command: + +```sh +docker-compose down --rmi all +``` diff --git a/docs/images/safari-develop-menu.png b/docs/images/safari-develop-menu.png new file mode 100644 index 000000000..af2b58d9a Binary files /dev/null and b/docs/images/safari-develop-menu.png differ diff --git a/docs/index.html b/docs/index.html index 2530e9341..6edc5d821 100644 --- a/docs/index.html +++ b/docs/index.html @@ -17,6 +17,20 @@ { title: 'Home', path: '/' + }, + { + title: 'Docker', + path: 'docker' + }, + { + title: 'Guides', + type: 'dropdown', + items: [ + { + title: 'CORS', + path: 'cors' + } + ] } ], icons: [