-
Notifications
You must be signed in to change notification settings - Fork 112
Add C# plugin specific restrictions to documentation #817
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
LakatosMark1
wants to merge
3
commits into
Ericsson:feature/csharp_plugin
Choose a base branch
from
LakatosMark1:feature/csharp_plugin
base: feature/csharp_plugin
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -31,6 +31,9 @@ Table of Contents | |
| * [Build image for development](#build-image-for-development) | ||
| * [How to use docker to develop CodeCompass](#how-to-use-docker-to-develop-codecompass) | ||
| * [Build, install and test CodeCompass](#build-install-and-test-codecompass) | ||
| * [Make a Postgresql container](#make-a-postgresql-container) | ||
| * [Create a network and connect CodeCompass and Postgres](#create-a-network-and-connect-codecompass-and-postgres) | ||
| * [Create a Postgres user](#create-a-postgres-user) | ||
| * [How to parse a project](#how-to-parse-a-project) | ||
| * [How to start a webserver](#how-to-start-a-webserver) | ||
| * [Deployment](#deployment) | ||
|
|
@@ -60,7 +63,7 @@ First, you have to start a docker container from this image, which will mount | |
| your CodeCompass directory from your host and starts a shell: | ||
| ```bash | ||
| docker run --rm -ti \ | ||
| --env DATABASE=sqlite --env BUILD_TYPE=Release \ | ||
| --env DATABASE=pgsql --env BUILD_TYPE=Release \ | ||
| --volume /path/to/host/CodeCompass:/CodeCompass \ | ||
| --volume /path/to/your/host/project:/projects/myproject \ | ||
| -p 8001:8080 \ | ||
|
|
@@ -77,6 +80,7 @@ have to mount a project directory if you do not want to parse it later. | |
| ### Build, install and test CodeCompass | ||
| You can use the `codecompass-build.sh` script inside the container to build, | ||
| install and test CodeCompass: | ||
| (If you get a timeout error when downloading, put this command before install: NODE_OPTIONS="--max-old-space-size=4096" NEXT_PRIVATE_BUILD_WORKER_TIMEOUT=600) | ||
| ```bash | ||
| # Build CodeCompass. | ||
| codecompass-build.sh -j8 | ||
|
|
@@ -88,25 +92,55 @@ codecompass-build.sh install | |
| codecompass-build.sh test | ||
| ``` | ||
|
|
||
| ### Make a Postgresql container | ||
| You need to create a PostgreSQL container that CodeCompass can communicate with. | ||
| (postgres is the image name and :15 is the specific version) | ||
| ```bash | ||
| docker run \ | ||
| --name postgres_container \ | ||
| -e POSTGRES_PASSWORD=root_password \ | ||
| -d \ | ||
| -p 5432:5432 \ | ||
| postgres:15 | ||
| ``` | ||
|
|
||
| ### Create a network and connect CodeCompass and Postgres | ||
| Run the containers and connect them to a nework | ||
| ```bash | ||
| docker network create my_network | ||
| docker network connect my_network postgres_name | ||
| docker network connect my_network codecompass_container | ||
| ``` | ||
| ### Create a Postgres user | ||
| You need to create a Postgres user and give it admin rights. | ||
| (Run these commands from the host computer) | ||
| ```bash | ||
| # 1. Create user "your_user" with password "your_password" | ||
| docker exec -it postgres_container psql -U postgres -d postgres -c "CREATE USER your_user WITH PASSWORD 'your_password';" | ||
|
|
||
| # 2. Adunk neki Superuser jogot (hogy biztosan tudjon adatbázist írni/olvasni) | ||
| docker exec -it postgres_container psql -U postgres -d postgres -c "ALTER USER your_user WITH SUPERUSER;" | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe this could be a single command with the above one. |
||
| ``` | ||
|
|
||
| ### How to parse a project | ||
| You can parse a project inside a docker container by using the following | ||
| command: | ||
| (The project must be built before parsing.) | ||
| ```bash | ||
| CodeCompass_parser \ | ||
| -d "sqlite:database=/CodeCompass/workspace/myproject/data.sqlite" \ | ||
| -d "pgsql:database=myproject;host=codecompass-postgres;port=5432;user=your_user;password=your_password" \ | ||
| -w /CodeCompass/workspace \ | ||
| -n myproject \ | ||
| -i /projects/myproject | ||
| -b /projects/myproject/projectname/bin/Debug \ | ||
| -f | ||
| ``` | ||
|
|
||
| *Note*: the project directory should be mounted inside the container. | ||
|
|
||
| ### How to start a webserver | ||
| You can start a webserver inside the container by using the following command: | ||
| ```bash | ||
| # Create a workspace directory. | ||
| mkdir -p /CodeCompass/workspace | ||
|
|
||
| # Run the web server. | ||
| CodeCompass_webserver \ | ||
| -w /CodeCompass/workspace | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Translate to English :)