The system administrator documentation for Zammad.
Home Page: https://docs.zammad.org
License: GNU Affero General Public License v3.0
(pre-release)
(latest)
Source files for Zammad’s documentation.
Please see the Contributing section in this manual.
sphinx
$ pip install -r requirements.txt
make html
A typo in our "make new states available to ui" -script causes the new state to be available to agents during editing a ticket.
This is unintended and invalid.
Hi all,
We can create mobile app by using this api. Can you support push notification service for IOS and Android App?
For example when user create ticket or answer ticket, other user get the notification for this actions.
Thanks for your help.
In order to help contributors and also other members, we need to have a common rule set for a global goal.
This should help to reduce discussions where to find what and if something is really required to add / provide.
Regarding the Mail channel documentation, it reads
Sorry, this still needs to be added :-(
Out of curiosity, where would one start? The ways to receive mails with an Rails application range from configuring a IMAP or POP3 client, using a Webhook for external mail services to setting up a local MTA (and, in case of Postfix, adding a transport to /etc/postfix/master.cf).
What is available in Zammad? Which source code do I need to read? Are there example stubs I could reuse?
This thread was moved to zammad/zammad-docker-compose project
Hi guys, I have this problem, maybe you can help me and by the way, we'll improve the documentation.
When I launch the "docker compose up" command
i got this error:
Starting c95b44daa0ae_zammad-docker-compose_zammad-nginx_1 ... error
ERROR: for c95b44daa0ae_zammad-docker-compose_zammad-nginx_1 Cannot start service zammad-nginx: b'driver failed programming external connectivity on endpoint Starting zammad-docker-compose_zammad-init_1 ... done
0.0.0.0:80: bind: address already in use'
ERROR: for zammad-nginx Cannot start service zammad-nginx: b'driver failed programming external connectivity on endpoint c95b44daa0ae_zammad-docker-compose_zammad-nginx_1 (2a916ee18be6b598e82f2994b4c1bbb931bf8e2aa24fee14924918bb72b78358): Error starting userland proxy: listen tcp 0.0.0.0:80: bind: address already in use'
ERROR: Encountered errors while bringing up the project.
I tried to set the port by hand inside the docker-compose, but I can't find the quick fix. I don't want to have to modify the entrypoints of the folders. Does anyone know a simple solution?
My goal is to get zammad to launch into port 9096:80.
A progress update would be great in the OTRS migrator.
Afaik a very simple one would do a great job:
it would make the life much easier for admins to extrapolate how long the migration will take.
What I do:
FROM: https://docs.zammad.org/en/latest/appendix-repo-file.html
apt-key adv --keyserver http://dl.packager.io/srv/zammad/zammad/key --recv-keys 6257DF9972462F57A20FFB2AB6D583CCBD33EEB8
Executing: /tmp/tmp.wg1FWjtcEn/gpg.1.sh --keyserver
http://dl.packager.io/srv/zammad/zammad/key
--recv-keys
6257DF9972462F57A20FFB2AB6D583CCBD33EEB8
gpg: requesting key BD33EEB8 from http server dl.packager.io
gpgkeys: no key data found for http://dl.packager.io/srv/zammad/zammad/key
gpg: no valid OpenPGP data found.
gpg: Total number processed: 0
gpg: keyserver communications error: key not found
gpg: keyserver communications error: bad public key
gpg: keyserver receive failed: bad public key
What I expect.
The Key.
@martini pointed out that the "Single Sign-On" page should contain an addition "for Kerberos" to make it clearer where the document aims to.
Hello!
I was looking through the website on zammad.org, and documentation on docs.zammad.org and I couldn't find a clear list of features for what zammad supports.
For exemple, it supports interaction via email I suppose.. is it possible to integrate any other comms system with it? Is there some way to easily classify requests like queues (similar to RT) or tags or some other method? ... and there's probably so much more.
it would be great to see such a list of features on the website and in the docs.
Sorry for reaching out this way, Actually I have written an article on zammad and created a comparison table hope this gonna help you.
THe installation from source as described here
https://github.com/zammad/zammad-documentation/blob/master/install-source.rst
does not work out.
When unpacking the tgz as mentioned, the files belong to 501:staff!
root@shell> useradd zammad
root@shell> su - zammad
Then user zammad has no access to /opt/zammad !
When running
gem install bundler
the user zammad has no access rights to /var...
zammad@zammad:/opt/zammad$ gem install bundler
ERROR: While executing gem ... (Gem::FilePermissionError)
You don't have write permissions for the /var/lib/gems/2.3.0 directory.
It is unclear if the gems should be install systemwide (as root) or locally (as zammad). But then the access rights are not straight.
Special characters should be encoded proberly - right now our documentation offers ideas that might not work as expected at some point.
Hi,
I wanted to ask if you maybe could give an example for using the API.
I want to copy the behavior of the UI + button, which creates a new ticket, to the API.
So I want to create a new user by writing him an email and also having this created as a new ticket.
I'm struggling because this means creating a new user AND a new ticket AND an email.
Hope this is OK to ask for. If not I'm sorry for bothering.
like OTRS occ.
Infos about how to make design changes can be found here:
http://read-the-docs.readthedocs.io/en/latest/design.html
http://read-the-docs.readthedocs.io/en/latest/index.html#designer-documentation
The elasticsearch installation guide did not work for me
https://docs.zammad.org/en/latest/install-elasticsearch.html#ubuntu-16-04
-> elasticsearch-plugin was not found
With the steps described here https://askubuntu.com/questions/848173/how-to-install-elasticsearch-on-16-04-lts I got it working somehow (still, not quite sure how to check if it is running correctly).
Regards,
aMuTeX
please add repo description and link (to zammad.readthedocs.io)
Some text might be miss leading and cause irritation.
Especially the Direct calling part can be confusing, as this might suggest that Zammad polls the telephony system (which it does not).
Outgoing from zammad/zammad#1271:
In https://docs.zammad.org/en/latest/prerequisites-hardware.html you write:
* 2 CPU
Do you mean 2 CPUs/ or 2 cores? (two dual-processors would be quite demanding)
Also you write 2 CPU and then 4 CPUs (with a 's'). That's not consistent. I know, minor issue, but still.
Originally came from @rolfschmidt
Ticket.where(customer: user).find_each do |ticket|
puts " Deleting ticket ##{ticket.number}..."
ticket.destroy
end
puts " Removing references for user with email #{user.email}..."
ActivityStream.where(created_by_id: user.id).update_all(created_by_id: 1)
History.where(created_by_id: user.id).update_all(created_by_id: 1)
Ticket::Article.where(created_by_id: user.id).update_all(created_by_id: 1)
Ticket::Article.where(updated_by_id: user.id).update_all(updated_by_id: 1)
Store.where(created_by_id: user.id).update_all(created_by_id: 1)
StatsStore.where(created_by_id: user.id).update_all(created_by_id: 1)
Tag.where(created_by_id: user.id).update_all(created_by_id: 1)
OnlineNotification.find_by(user_id: user.id)&.destroy!
This block may get removed because of the data privacy changes. Normally you now only need user.destroy because all references are now cleared on the destroy call.
I want to delete count of users and organisation in zammad interface
Due to newest changes within Elastic licensing and stuff, elasticsearch-oss will be the new ES dependency of Zammad for upcoming 4.0 release.
See zammad/zammad#3355 (comment) for more input
During a source code installation there's no explicit warning that your database has to be UTF-8.
Usually this is the case, however, in some rare cases your may have other encodings on your postgreSQL system (for whatever reason).
This issue occured on the community:
https://community.zammad.org/t/bundle-exec-rake-db-seed-error/4776/13
We should state better which encoding is required.
Console part needs some input on "how to create ticket priorities" and stuff
I currently in the testing phase and conducted a LDAP import before I set the the organization domain which resulted in no origination allocated to users. What would be the command to remove all users.
Clean Ubutnu repo install
We should enhance our documentation.
It was noted on a blog that Zammads documentation is "in a bad state".
This especially affects the API part where we should enhance the following:
Reference Blog post was: https://rixx.de/blog/mobile-zammad-notifications-with-pushover/
As it seems that Debian 10 support is there, is it time already to make it official in the Zammad documentation ?
https://packager.io/gh/zammad/zammad/refs/stable
Right now the translation documentation doesn't provide target_initial which actually would be a good idea for custom translations. Right now, if you use our suggested code, all translations (even if they don't belong to a core installation of Zammad) will be pushed to our translation server.
This ends up in having translations for stuff nobody else uses and thus could be enhanced.
As OTRS3 is support by our migrator (and there's actually a download available for version 3) there should also be a repository download for OTRS3. If user doesn't have this repository, he can't install the migrator-plugin successfull.
Link to documentation:
https://docs.zammad.org/en/latest/migration-otrs.html
which container to backup and restore?
Add office gitlab an linkedin docs
We need to add further documentation to docs and admin-docs for the following issue:
zammad/zammad#1880
This will help users to address this "issue", if it is one. :)
Ticket::Article::Type.find_by(name:'note').update!(communication: true)
The Steps on the Page https://docs.zammad.org/en/latest/install-docker-compose.html are not working
i am getting the following Error:
git clone [email protected]:zammad/zammad-docker-compose.git
Klone nach 'zammad-docker-compose' ...
The authenticity of host 'github.com (192.30.253.112)' can't be established.
RSA key fingerprint is SHA256:nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8.
Are you sure you want to continue connecting (yes/no)? yes
Warning: Permanently added 'github.com,192.30.253.112' (RSA) to the list of known hosts.
Permission denied (publickey).
fatal: Could not read from remote repository.
Please make sure you have the correct access rights
and the repository exists.
when i changed the commando to
git clone https://github.com/zammad/zammad-docker-compose.git
it worked. Can you change the Documentation then?
Hello,
We would like to update an object via REST API but there is no information provided on how a request should look like. An empty request returns
{
"error": "undefined method `match?' for nil:NilClass"
}
https://docs.zammad.org/en/latest/api/object.html#update
PUT /api/v1/object_manager_attributes/:id
We would like to update the options for the attached show object.
Many thanks for any additional information.
Show Request
{
"id": 50,
"object_lookup_id": 2,
"name": "house",
"display": "Liegenschaft",
"data_type": "select",
"data_option": {
"options": {
"19": "Teststrasse 1",
"20": "Teststrasse 2",
"21": "Teststrasse 3",
"null": "Kein Mandat"
},
"linktemplate": "",
"default": "",
"null": true,
"relation": "",
"nulloption": true,
"maxlength": 255,
"historical_options": {
"19": "Teststrasse 1",
"20": "Teststrasse 2",
"21": "Teststrasse 3",
"null": "Kein Mandat"
}
},
"data_option_new": {
"options": {
"19": "Teststrasse 1",
"20": "Teststrasse 2",
"null": "Kein Mandat"
},
"linktemplate": "",
"default": "",
"null": true,
"relation": "",
"nulloption": true,
"maxlength": 255
},
"editable": true,
"active": true,
"screens": {
"create_middle": {
"ticket.customer": {
"shown": true,
"required": false,
"item_class": "column"
},
"ticket.agent": {
"shown": true,
"required": true,
"item_class": "column"
}
},
"edit": {
"ticket.customer": {
"shown": true,
"required": false
},
"ticket.agent": {
"shown": true,
"required": true
}
}
},
"to_create": false,
"to_migrate": false,
"to_delete": false,
"to_config": true,
"position": 1550,
"created_by_id": 4,
"updated_by_id": 4,
"created_at": "2020-10-13T13:18:18.931Z",
"updated_at": "2020-10-29T09:16:40.567Z"
}
Somewhere between Zammad 3.2 and 3.4 something changed with the authorization part in Zammad causing CSRF token errors and invalid token errors.
The reason for that is that the expected string seemed to change:
old:
-H "Authorization: Token token={your_token}"
new
-H "Authorization: Bearer {your_token}"
the documentation does not say something about how to delete user via Console.
For the sake of completeness this should be added, because otherwise it is misleading if there is only information about deleting users with the help of the API.
The hint that there can be side effects should of course be included.
The API payloads for ticket creations are outdated and partly no longer working.
This documentation part needs some ove.
The mandatory software list is outdated and incorrect.
Elasticsearch is optional, not mandatory.
This should be updated within documentation.
Hy, it seems that the facebook integration is outdated.
It doesent reflect the current way Facebook handles the app creation.
Please update the docs.
https://docs.zammad.org/en/latest/channel-facebook.html#register-facebook-app
Extend REST API documentation with new mentions feature
Hello Zammad,
Just wanted to ask a question about Swagger API definition of Zammad, would it be possible to get a swagger definition of the entire API's supported methods, this would allow people to test against it a bit better and to put API management software in-front of it.
Thank you very much!
Amazing work on zammad its really awesome!
Commands are at some parts formatted incorrectly, we should check it completely and ensure everything is good to go.
e.g. cti customer last activity
There is now the possibility to have custom update save notification templates: zammad/zammad#2081 (comment)
The documentation should get extended to reflect these changes.
Kapitel: Install on CentOS via RPM
Die Überschriften U1 bis U3 in diesem Kapitel sind durcheinandergeraten.
Chapter: Install on CentOS via RPM
The headings U1 to U3 in this chapter are confused.
We really should fix this, we haven't updated master in ages.
https://docs.zammad.org/en/latest/contributing-branches.html
This question arised on the Community: https://community.zammad.org/t/branching-model/3120
hello, All,
after installing zammad on CentOS only the ngnix test page appears instead of zammad web page.
Thanks
Self Explanatory screenshot
He,
Within the docs there is a section Console.
It starts with entering the console for zammad and ends with one command, which can only be meant as an example right? :)
Is there a list of all available commands? Just for fun I tested User.destroy_all. It is working ...
Is there a roadmap for adding information to the docs?
Best regards
sthag
As we have working installers for Centos, Debian, Ubuntu & Suse we could move "Install from source (generic)", "Install with Docker" & "Install with Vagrant" to the "Contributing / Development" section.
What do you think?
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.